diff --git a/.github/workflows/docs-tests.yml b/.github/workflows/docs-tests.yml index 030cd3249933b..233418e270f33 100644 --- a/.github/workflows/docs-tests.yml +++ b/.github/workflows/docs-tests.yml @@ -5,6 +5,7 @@ on: branches: ['master'] paths: - 'apps/docs/**/*.ts*' + - 'apps/docs/spec/**/*.json' # Cancel old builds on new commit for same workflow + branch/PR concurrency: diff --git a/apps/docs/content/guides/auth/jwts.mdx b/apps/docs/content/guides/auth/jwts.mdx index 9edce569f2862..f9f7209ea5fda 100644 --- a/apps/docs/content/guides/auth/jwts.mdx +++ b/apps/docs/content/guides/auth/jwts.mdx @@ -6,7 +6,7 @@ subtitle: 'Information on how best to use JSON Web Tokens with Supabase' A [JSON Web Token](https://jwt.io/introduction) is a type of data structure, represented as a string, that usually contains identity and authorization information about a user. It encodes information about its lifetime and is signed with a cryptographic key to make it tamper-resistant. -Supabase Auth continuously issues a new JWT for each user session, for as long as the user remains signed in. Check the comprehensive guide on [Sessions](/docs/guides/sessions) to find out how you can tailor this process for your needs. +Supabase Auth continuously issues a new JWT for each user session, for as long as the user remains signed in. Check the comprehensive guide on [Sessions](/docs/guides/auth/sessions) to find out how you can tailor this process for your needs. JWTs provide the foundation for [Row Level Security](/docs/guides/database/row-level-security). Each Supabase product is able to securely decode and verify the validity of a JWT it receives before using Postgres policies and roles to authorize access to the project's data. diff --git a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap index 935a8a819855e..5f662aea74961 100644 --- a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap +++ b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap @@ -34,6 +34,36 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "SupabaseClientOptions", "type": "object", "properties": [ + { + "name": "accessToken", + "type": { + "type": "function", + "params": [], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + } + }, + "comment": { + "shortText": "Optional function for using a third-party authentication system with\\nSupabase. The function should return an access token or ID token (JWT) by\\nobtaining it from the third-party auth client library. Note that this\\nfunction may be called concurrently and many times. Use memoization and\\nlocking techniques if this is not supported by the client libraries.\\n\\nWhen set, the \`auth\` namespace of the Supabase client cannot be used.\\nCreate another client if you wish to use Supabase Auth and third-party\\nauthentications concurrently in the same application." + } + }, + "isOptional": true + }, { "name": "auth", "type": { @@ -95,7 +125,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "tags": [ { "tag": "experimental", - "text": "\\n" + "text": "" } ] } @@ -132,6 +162,23 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "comment": { "shortText": "Optional key name used for storing tokens in local storage." } + }, + { + "name": "userStorage", + "type": { + "type": "nameOnly", + "name": "SupabaseAuthClientOptions['userStorage']" + }, + "isOptional": true, + "comment": { + "shortText": "A storage provider to store the user profile separately from the session.\\nUseful when you need to store the session information in cookies,\\nwithout bloating the data with the redundant user object.", + "tags": [ + { + "tag": "experimental", + "text": "" + } + ] + } } ] }, @@ -204,32 +251,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, { - "type": "function", - "name": "accessToken", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } + "name": "storage", + "type": { + "type": "nameOnly", + "name": "@supabase/storage-js.StorageClientOptions" }, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\\nSupabase. The function should return an access token or ID token (JWT) by\\nobtaining it from the third-party auth client library. Note that this\\nfunction may be called concurrently and many times. Use memoization and\\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the \`auth\` namespace of the Supabase client cannot be used.\\nCreate another client if you wish to use Supabase Auth and third-party\\nauthentications concurrently in the same application.\\n" - } + "isOptional": true } ] }, @@ -430,7 +457,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "@supabase/realtime-js.RealtimeChannelOptions" }, "comment": { - "shortText": "The options to pass to the Realtime channel.\\n\\n" + "shortText": "The options to pass to the Realtime channel." } } ], @@ -454,7 +481,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "TableName" }, "comment": { - "shortText": "The table or view name to query\\n" + "shortText": "The table or view name to query" } } ], @@ -477,7 +504,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "ViewName" }, "comment": { - "shortText": "The table or view name to query\\n" + "shortText": "The table or view name to query" } } ], @@ -552,7 +579,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "@supabase/realtime-js.RealtimeChannel" }, "comment": { - "shortText": "The name of the Realtime channel.\\n\\n" + "shortText": "The name of the Realtime channel." } } ], @@ -632,7 +659,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -684,7 +711,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "DynamicSchema" }, "comment": { - "shortText": "The schema to query\\n" + "shortText": "The schema to query" } } ], @@ -695,8 +722,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\\n" + "shortText": "Select a schema to query or perform an function (rpc) call.\\n\\nThe schema needs to be on the list of exposed schemas inside Supabase." } } } @@ -1286,8 +1312,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.", - "text": "Only a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information.\\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." } }, { @@ -1298,8 +1323,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user.\\n" + "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." } }, { @@ -1321,8 +1345,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\\n" + "shortText": "Confirms the user's email address if set to true.\\n\\nOnly a service role can modify." } }, { @@ -1333,8 +1356,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`id\` for the user.", - "text": "Allows you to overwrite the default \`id\` set for the user.\\n" + "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." } }, { @@ -1345,8 +1367,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\\n" + "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." } }, { @@ -1368,8 +1389,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`password_hash\` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\\n" + "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." } }, { @@ -1391,8 +1411,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\\n" + "shortText": "Confirms the user's phone number if set to true.\\n\\nOnly a service role can modify." } }, { @@ -1403,8 +1422,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges.\\n" + "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." } }, { @@ -1415,8 +1433,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data.\\n\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." } } ] @@ -1872,7 +1889,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "boolean" }, "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\\nDefaults to false for backward compatibility.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.\\n" + "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\\nDefaults to false for backward compatibility.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." } } ], @@ -2337,8 +2354,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -2398,8 +2414,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -3063,7 +3078,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The user's unique identifier\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.\\n" + "shortText": "The user's unique identifier\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." } } ], @@ -3539,7 +3554,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "Additional options to be included when inviting.\\n" + "shortText": "Additional options to be included when inviting." } } ], @@ -4007,7 +4022,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "An object which supports \`page\` and \`perPage\` as numbers, to alter the paginated results.\\n" + "shortText": "An object which supports \`page\` and \`perPage\` as numbers, to alter the paginated results." } } ], @@ -4061,8 +4076,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your \`service_role\` key in the browser." + "shortText": "Get a list of users.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." } }, "@supabase/auth-js.GoTrueAdminApi.signOut": { @@ -4098,7 +4112,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The logout sope.\\n" + "shortText": "The logout sope." } } ], @@ -4164,8 +4178,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.", - "text": "Only a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information.\\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." } }, { @@ -4176,8 +4189,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user.\\n" + "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." } }, { @@ -4199,8 +4211,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\\n" + "shortText": "Confirms the user's email address if set to true.\\n\\nOnly a service role can modify." } }, { @@ -4211,8 +4222,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`id\` for the user.", - "text": "Allows you to overwrite the default \`id\` set for the user.\\n" + "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." } }, { @@ -4223,8 +4233,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\\n" + "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." } }, { @@ -4246,8 +4255,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`password_hash\` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\\n" + "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." } }, { @@ -4269,8 +4277,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\\n" + "shortText": "Confirms the user's phone number if set to true.\\n\\nOnly a service role can modify." } }, { @@ -4281,8 +4288,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges.\\n" + "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." } }, { @@ -4293,14 +4299,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data.\\n\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." } } ] }, "comment": { - "shortText": "The data you want to update.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.\\n" + "shortText": "The data you want to update.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." } } ], @@ -4837,7 +4842,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "tags": [ { "tag": "experimental", - "text": "\\n" + "text": "" } ] } @@ -4900,7 +4905,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The operation to execute when the lock is acquired.\\n" + "shortText": "The operation to execute when the lock is acquired." } } ], @@ -4919,7 +4924,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "tags": [ { "tag": "experimental", - "text": "\\n" + "text": "" } ] } @@ -4930,7 +4935,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "tags": [ { "tag": "experimental", - "text": "\\n" + "text": "" } ] } @@ -4967,12 +4972,11 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "userStorage", "isOptional": true, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, \`storage\` will only store a JSON object containing the access and refresh token and some adjacent metadata, while \`userStorage\` will only contain the user object under the key \`storageKey + '-user'\`.", - "text": "When this option is set and cookie storage is used, \`getSession()\` and other functions that load a session from the cookie store might not return back a user. It's very important to always use \`getUser()\` to fetch a user object in those scenarios.\\n", + "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, \`storage\` will only store a JSON object containing the access and refresh token and some adjacent metadata, while \`userStorage\` will only contain the user object under the key \`storageKey + '-user'\`.\\n\\nWhen this option is set and cookie storage is used, \`getSession()\` and other functions that load a session from the cookie store might not return back a user. It's very important to always use \`getUser()\` to fetch a user object in those scenarios.", "tags": [ { "tag": "experimental", - "text": "\\n" + "text": "" } ] } @@ -5909,7 +5913,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\\n can obtain from {@link #getSession}." + "shortText": "An optional specific JWT you wish to verify, not the one you\\n can obtain from #getSession." } }, { @@ -6056,12 +6060,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "isOptional": true, - "comment": {} + "comment": { + "shortText": "" + } } ] }, "comment": { - "shortText": "Various additional options that allow you to customize the\\n behavior of this method.\\n" + "shortText": "Various additional options that allow you to customize the\\n behavior of this method." } } ], @@ -6192,8 +6198,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\\nJWT against the server's JSON Web Key Set endpoint\\n\`/.well-known/jwks.json\` which is often cached, resulting in significantly\\nfaster responses. Prefer this method over {@link #getUser} which always\\nsends a request to the Auth server for each JWT.", - "text": "If the project is not using an asymmetric JWT signing key (like ECC or\\nRSA) it always sends a request to the Auth server (similar to {@link\\n#getUser}) to verify the JWT.\\n" + "shortText": "Extracts the JWT claims present in the access token by first verifying the\\nJWT against the server's JSON Web Key Set endpoint\\n\`/.well-known/jwks.json\` which is often cached, resulting in significantly\\nfaster responses. Prefer this method over #getUser which always\\nsends a request to the Auth server for each JWT.\\n\\nIf the project is not using an asymmetric JWT signing key (like ECC or\\nRSA) it always sends a request to the Auth server (similar to #getUser) to verify the JWT." } }, "@supabase/auth-js.GoTrueClient.getSession": { @@ -6751,8 +6756,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Returns the session, refreshing it if necessary.", - "text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\\n\\n**IMPORTANT:** This method loads values directly from the storage attached\\nto the client. If that storage is based on request cookies for example,\\nthe values in it may not be authentic and therefore it's strongly advised\\nagainst using this method and its results in such circumstances. A warning\\nwill be emitted if this is detected. Use {@link #getUser()} instead.\\n" + "shortText": "Returns the session, refreshing it if necessary.\\n\\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\\n\\n**IMPORTANT:** This method loads values directly from the storage attached\\nto the client. If that storage is based on request cookies for example,\\nthe values in it may not be authentic and therefore it's strongly advised\\nagainst using this method and its results in such circumstances. A warning\\nwill be emitted if this is detected. Use #getUser() instead." } }, "@supabase/auth-js.GoTrueClient.getUser": { @@ -6766,7 +6770,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\\n" + "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." } } ], @@ -8349,7 +8353,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\\n" + "shortText": "A callback function to be invoked when an auth event happens." } } ], @@ -8369,554 +8373,558 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Subscription", "properties": [ { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - } - }, - { - "type": "function", "name": "callback", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] + "type": { + "type": "function", + "params": [ + { + "name": "event", + "type": { + "type": "union", + "name": "AuthChangeEvent", + "subTypes": [ + { + "type": "literal", + "value": "INITIAL_SESSION" + }, + { + "type": "literal", + "value": "PASSWORD_RECOVERY" + }, + { + "type": "literal", + "value": "SIGNED_IN" + }, + { + "type": "literal", + "value": "SIGNED_OUT" + }, + { + "type": "literal", + "value": "TOKEN_REFRESHED" + }, + { + "type": "literal", + "value": "USER_UPDATED" + }, + { + "type": "literal", + "value": "MFA_CHALLENGE_VERIFIED" + } + ] + } + }, + { + "name": "session", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": null + }, + { + "type": "object", + "name": "Session", + "properties": [ + { + "name": "access_token", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + } }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] + { + "name": "expires_at", + "type": { + "type": "intrinsic", + "name": "number" + }, + "isOptional": true, + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." + } }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "expires_in", + "type": { + "type": "intrinsic", + "name": "number" + }, + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + } }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "provider_refresh_token", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": null }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - }, - { - "name": "aud", - "type": { + { "type": "intrinsic", "name": "string" } - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" + ] + }, + "isOptional": true, + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + } + }, + { + "name": "provider_token", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": null }, - "isOptional": true - }, - { - "name": "created_at", - "type": { + { "type": "intrinsic", "name": "string" } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" + ] + }, + "isOptional": true, + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + } + }, + { + "name": "refresh_token", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "A one-time used refresh token that never expires." + } + }, + { + "name": "token_type", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "user", + "type": { + "type": "object", + "name": "User", + "properties": [ + { + "name": "action_link", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { + { + "name": "app_metadata", + "type": { "type": "object", - "name": "Factor", + "name": "UserAppMetadata", "properties": [ { - "name": "created_at", + "name": "provider", "type": { "type": "intrinsic", "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" + "isOptional": true + } + ] + } + }, + { + "name": "aud", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "confirmation_sent_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "confirmed_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "deleted_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "email", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "email_change_sent_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "email_confirmed_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "factors", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + } }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "factor_type", + "type": { + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] + }, + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" + } }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "verified" - }, - { - "type": "literal", - "value": "unverified" - } - ] + { + "name": "friendly_name", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." + } }, - "comment": { - "shortText": "Factor's status." - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "ID of the factor." + } + }, + { + "name": "status", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "verified" + }, + { + "type": "literal", + "value": "unverified" + } + ] + }, + "comment": { + "shortText": "Factor's status." + } + }, + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ] + ] + } + }, + "isOptional": true + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" } }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "identities", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "UserIdentity", + "properties": [ + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { + { + "name": "id", + "type": { "type": "intrinsic", "name": "string" + } + }, + { + "name": "identity_data", + "type": { + "type": "index signature", + "keyType": { + "type": "intrinsic", + "name": "string" + }, + "valueType": { + "type": "intrinsic", + "name": "any" + } }, - "valueType": { + "isOptional": true + }, + { + "name": "identity_id", + "type": { "type": "intrinsic", - "name": "any" + "name": "string" } }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "last_sign_in_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "provider", + "type": { + "type": "intrinsic", + "name": "string" + } }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "user_id", + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ] - } + ] + } + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "invited_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" + { + "name": "is_sso_user", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "last_sign_in_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "new_email", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "new_phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "phone_confirmed_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "recovery_sent_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "role", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] + { + "name": "user_metadata", + "type": { + "type": "object", + "name": "UserMetadata", + "properties": [] + } } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + ] + }, + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + } } - } - ] - } - ] + ] + } + ] + } } + ], + "ret": { + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "comment": { + "shortText": "The function to call every time there is an event. eg: (eventName) => {}" } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } + } + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" }, "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" + "shortText": "The subscriber UUID. This will be set by the client." } }, { - "type": "function", "name": "unsubscribe", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" + "type": { + "type": "function", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "comment": { + "shortText": "Call this to remove the listener." } - }, - "comment": { - "shortText": "Call this to remove the listener." } } ] @@ -9874,7 +9882,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\\n" + "shortText": "The current session. If passed in, it must contain a refresh token." } } ], @@ -11062,7 +11070,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\\n" + "shortText": "Verification token received when the user completes the captcha on the site." } }, { @@ -11154,7 +11162,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The current session that minimally contains an access token and refresh token.\\n" + "shortText": "The current session that minimally contains an access token and refresh token." } } ], @@ -12111,8 +12119,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } } ] @@ -13041,8 +13048,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Creates a new anonymous user.", - "returns": "A session where the is_anonymous claim in the access token JWT set to true\\n" + "shortText": "Creates a new anonymous user." } }, "@supabase/auth-js.GoTrueClient.signInWithIdToken": { @@ -14527,8 +14533,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -14606,8 +14611,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -14756,8 +14760,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).", - "text": "If the \`{{ .ConfirmationURL }}\` variable is specified in the email template, a magiclink will be sent.\\nIf the \`{{ .Token }}\` variable is specified in the email template, an OTP will be sent.\\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\\n\\nBe aware that you may get back an error message that will not distinguish\\nbetween the cases where the account does not exist or, that the account\\ncan only be accessed via social login.\\n\\nDo note that you will need to configure a Whatsapp sender on Twilio\\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\\nchannel is not supported on other providers\\nat this time.\\nThis method supports PKCE when an email is passed.\\n" + "shortText": "Log in a user using magiclink or a one-time password (OTP).\\n\\nIf the \`{{ .ConfirmationURL }}\` variable is specified in the email template, a magiclink will be sent.\\nIf the \`{{ .Token }}\` variable is specified in the email template, an OTP will be sent.\\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\\n\\nBe aware that you may get back an error message that will not distinguish\\nbetween the cases where the account does not exist or, that the account\\ncan only be accessed via social login.\\n\\nDo note that you will need to configure a Whatsapp sender on Twilio\\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\\nchannel is not supported on other providers\\nat this time.\\nThis method supports PKCE when an email is passed." } }, "@supabase/auth-js.GoTrueClient.signInWithPassword": { @@ -15812,8 +15815,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.", - "text": "Be aware that you may get back an error message that will not distinguish\\nbetween the cases where the account does not exist or that the\\nemail/phone and password combination is wrong or that the account can only\\nbe accessed via social login.\\n" + "shortText": "Log in an existing user with an email and password or phone and password.\\n\\nBe aware that you may get back an error message that will not distinguish\\nbetween the cases where the account does not exist or that the\\nemail/phone and password combination is wrong or that the account can only\\nbe accessed via social login." } }, "@supabase/auth-js.GoTrueClient.signInWithSSO": { @@ -15944,8 +15946,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\\ntaking the user to the identity provider's authentication flow.", - "text": "On browsers you can set the URL to \`window.location.href\` to take\\nthe user to the authentication flow.\\n" + "shortText": "URL to open in a browser which will complete the sign-in flow by\\ntaking the user to the identity provider's authentication flow.\\n\\nOn browsers you can set the URL to \`window.location.href\` to take\\nthe user to the authentication flow." } } ] @@ -15984,8 +15985,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\\nsuccessful SSO attempt will redirect the current page to the identity\\nprovider authorization page. The redirect URL is implementation and SSO\\nprotocol specific.", - "text": "You can use it by providing a SSO domain. Typically you can extract this\\ndomain by asking users for their email address. If this domain is\\nregistered on the Auth instance the redirect will use that organization's\\ncurrently active SSO Identity Provider for the login.\\n\\nIf you have built an organization-specific login page, you can use the\\norganization's SSO Identity Provider UUID directly instead.\\n" + "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\\nsuccessful SSO attempt will redirect the current page to the identity\\nprovider authorization page. The redirect URL is implementation and SSO\\nprotocol specific.\\n\\nYou can use it by providing a SSO domain. Typically you can extract this\\ndomain by asking users for their email address. If this domain is\\nregistered on the Auth instance the redirect will use that organization's\\ncurrently active SSO Identity Provider for the login.\\n\\nIf you have built an organization-specific login page, you can use the\\norganization's SSO Identity Provider UUID directly instead." } }, "@supabase/auth-js.GoTrueClient.signInWithWeb3": { @@ -16075,13 +16075,15 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "object", "properties": [ { - "type": "function", "name": "toBase58", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" + "type": { + "type": "function", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "string" + } } } } @@ -16096,82 +16098,97 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "isOptional": true }, { - "type": "function", "name": "signIn", - "params": [ - { - "name": "inputs", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "SolanaSignInInput" + "type": { + "type": "function", + "params": [ + { + "name": "inputs", + "type": { + "type": "array", + "elemType": { + "type": "nameOnly", + "name": "SolanaSignInInput" + } } } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "SolanaSignInOutput" - }, - { - "type": "array", - "elemType": { + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { "type": "nameOnly", "name": "SolanaSignInOutput" + }, + { + "type": "array", + "elemType": { + "type": "nameOnly", + "name": "SolanaSignInOutput" + } } - } - ] + ] + } } } - } + }, + "isOptional": true }, { - "type": "function", "name": "signMessage", - "params": [ - { - "name": "message", - "type": { - "type": "nameOnly", - "name": "Uint8Array" - } - }, - { - "name": "encoding", - "type": { - "type": "intrinsic", - "name": "string" + "type": { + "type": "function", + "params": [ + { + "name": "message", + "type": { + "type": "nameOnly", + "name": "Uint8Array" + } }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" + { + "name": "encoding", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "utf8" + }, + { + "type": "intrinsic", + "name": "string" + } + ] }, - { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Uint8Array" + "isOptional": true + } + ], + "ret": { + "type": { + "type": "union", + "subTypes": [ + { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "nameOnly", + "name": "Uint8Array" + } + }, + { + "type": "intrinsic", + "name": "undefined" } - } - ] + ] + } } - } + }, + "isOptional": true } ] }, @@ -17268,13 +17285,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\\nboth of which derive from the EIP-4361 standard\\nWith slight variation on Solana's side.", - "tags": [ - { - "tag": "reference", - "text": "https://eips.ethereum.org/EIPS/eip-4361\\n" - } - ] + "shortText": "Signs in a user by verifying a message signed by the user's private key.\\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\\nboth of which derive from the EIP-4361 standard\\nWith slight variation on Solana's side." } }, "@supabase/auth-js.GoTrueClient.signOut": { @@ -17342,8 +17353,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Inside a browser context, \`signOut()\` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a \`\\"SIGNED_OUT\\"\` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to \`auth.api.signOut(JWT: string)\`.\\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\\n\\nIf using \`others\` scope, no \`SIGNED_OUT\` event is fired!\\n" + "shortText": "Inside a browser context, \`signOut()\` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a \`\\"SIGNED_OUT\\"\` event.\\n\\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to \`auth.api.signOut(JWT: string)\`.\\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\\n\\nIf using \`others\` scope, no \`SIGNED_OUT\` event is fired!" } }, "@supabase/auth-js.GoTrueClient.signUp": { @@ -17392,8 +17402,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -17470,8 +17479,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } } ] @@ -18421,9 +18429,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Creates a new user.", - "text": "Be aware that if a user account exists in the system you may get back an\\nerror message that attempts to hide this information from the user.\\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\\n", - "returns": "A logged-in session if the server has \\"autoconfirm\\" ON" + "shortText": "Creates a new user.\\n\\nBe aware that if a user account exists in the system you may get back an\\nerror message that attempts to hide this information from the user.\\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." } }, "@supabase/auth-js.GoTrueClient.startAutoRefresh": { @@ -18440,8 +18446,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\\nevery few seconds. Close to the time of expiration a process is started to\\nrefresh the session. If refreshing fails it will be retried for as long as\\nnecessary.", - "text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\\nto call this function, it will be called for you.\\n\\nOn browsers the refresh process works only when the tab/window is in the\\nforeground to conserve resources as well as prevent race conditions and\\nflooding auth with requests. If you call this method any managed\\nvisibility change callback will be removed and you must manage visibility\\nchanges on your own.\\n\\nOn non-browser platforms the refresh process works *continuously* in the\\nbackground, which may not be desirable. You should hook into your\\nplatform's foreground indication mechanism and call these methods\\nappropriately to conserve resources.\\n\\n{@see #stopAutoRefresh}\\n" + "shortText": "Starts an auto-refresh process in the background. The session is checked\\nevery few seconds. Close to the time of expiration a process is started to\\nrefresh the session. If refreshing fails it will be retried for as long as\\nnecessary.\\n\\nIf you set the GoTrueClientOptions#autoRefreshToken you don't need\\nto call this function, it will be called for you.\\n\\nOn browsers the refresh process works only when the tab/window is in the\\nforeground to conserve resources as well as prevent race conditions and\\nflooding auth with requests. If you call this method any managed\\nvisibility change callback will be removed and you must manage visibility\\nchanges on your own.\\n\\nOn non-browser platforms the refresh process works *continuously* in the\\nbackground, which may not be desirable. You should hook into your\\nplatform's foreground indication mechanism and call these methods\\nappropriately to conserve resources.\\n\\n#stopAutoRefresh" } }, "@supabase/auth-js.GoTrueClient.stopAutoRefresh": { @@ -18458,8 +18463,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).", - "text": "If you call this method any managed visibility change callback will be\\nremoved and you must manage visibility changes on your own.\\n\\nSee {@link #startAutoRefresh} for more details.\\n" + "shortText": "Stops an active auto refresh process running in the background (if any).\\n\\nIf you call this method any managed visibility change callback will be\\nremoved and you must manage visibility changes on your own.\\n\\nSee #startAutoRefresh for more details." } }, "@supabase/auth-js.GoTrueClient.unlinkIdentity": { @@ -18608,8 +18612,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.", - "text": "The \`data\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\n" + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." } }, { @@ -18631,8 +18634,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\\n" + "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." } }, { @@ -19132,13 +19134,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\\n" - } - ] + "shortText": "Verification token received when the user completes the captcha on the site." } }, { @@ -19225,13 +19221,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\\n" - } - ] + "shortText": "Verification token received when the user completes the captcha on the site." } }, { @@ -20386,17 +20376,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\\nsessions if the deleted factor was verified.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\\n" - }, - { - "tag": "expermental", - "text": "\\n" - } - ] + "shortText": "Deletes a factor on a user. This will log the user out of all active\\nsessions if the deleted factor was verified." } }, "@supabase/auth-js.GoTrueAdminMFAApi.listFactors": { @@ -21269,7 +21249,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "shortText": "Friendly name of the factor, useful for distinguishing between factors *" } }, { @@ -21369,8 +21349,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\\nfactor. This method creates a new \`unverified\` factor.\\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\\nauthenticator app.\\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to \`aal2\`.\\n\\n" + "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\\nfactor. This method creates a new \`unverified\` factor.\\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\\nauthenticator app.\\nThe user has to enter the code from their authenticator app to verify it.\\n\\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to \`aal2\`." }, "altSignatures": [ { @@ -21440,7 +21419,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "shortText": "Friendly name of the factor, useful for distinguishing between factors *" } }, { @@ -21621,7 +21600,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "shortText": "Friendly name of the factor, useful for distinguishing between factors *" } }, { @@ -21737,7 +21716,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "shortText": "Friendly name of the factor, useful for distinguishing between factors *" } }, { @@ -21937,13 +21916,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\\nthan the current one, the user should go through MFA.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\\n" - } - ] + "shortText": "Next possible AAL level for the session. If the next level is higher\\nthan the current one, the user should go through MFA." } } ] @@ -21982,8 +21955,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- \`aal1\` (or \`null\`) means that the user's identity has been verified only\\nwith a conventional login (email+password, OTP, magic link, social login,\\netc.).\\n- \`aal2\` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\\n\\nAlthough this method returns a promise, it's fairly quick (microseconds)\\nand rarely uses the network. You can use this to check whether the current\\nuser needs to be shown a screen to verify their MFA factors.\\n\\n" + "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.\\n\\n- \`aal1\` (or \`null\`) means that the user's identity has been verified only\\nwith a conventional login (email+password, OTP, magic link, social login,\\netc.).\\n- \`aal2\` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\\n\\nAlthough this method returns a promise, it's fairly quick (microseconds)\\nand rarely uses the network. You can use this to check whether the current\\nuser needs to be shown a screen to verify their MFA factors." } }, "@supabase/auth-js.GoTrueMFAApi.listFactors": { @@ -22308,21 +22280,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, - { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\\n\\n" - } - ] + "shortText": "Returns the list of MFA factors enabled for this user." } }, "@supabase/auth-js.GoTrueMFAApi.unenroll": { @@ -22783,651 +22741,131 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "invited_at", "type": { "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\\nprovided by the user by entering a code seen in their authenticator app." - } - }, - "@supabase/auth-js.Subscription.callback": { - "name": "@supabase/auth-js.Subscription.callback", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "Factor", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "verified" - }, - { - "type": "literal", - "value": "unverified" - } - ] - }, - "comment": { - "shortText": "Factor's status." - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true + "name": "string" }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } + "isOptional": true + }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true + "isOptional": true + }, + { + "name": "is_sso_user", + "type": { + "type": "intrinsic", + "name": "boolean" }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } + "isOptional": true + }, + { + "name": "last_sign_in_at", + "type": { + "type": "intrinsic", + "name": "string" }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true + "isOptional": true + }, + { + "name": "new_email", + "type": { + "type": "intrinsic", + "name": "string" }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } + "isOptional": true + }, + { + "name": "new_phone", + "type": { + "type": "intrinsic", + "name": "string" }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true + "isOptional": true + }, + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } + "isOptional": true + }, + { + "name": "phone_confirmed_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "recovery_sent_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "role", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "user_metadata", + "type": { + "type": "object", + "name": "UserMetadata", + "properties": [] } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" + } + ] }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] + "comment": { + "shortText": "Updated user profile." } } ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "AuthError" } } ] @@ -23435,28 +22873,9 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] } } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - } - }, - "@supabase/auth-js.Subscription.unsubscribe": { - "name": "@supabase/auth-js.Subscription.unsubscribe", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } }, "comment": { - "shortText": "Call this to remove the listener." + "shortText": "Verifies a code against a challenge. The verification code is\\nprovided by the user by entering a code seen in their authenticator app." } } } @@ -23618,14 +23037,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\\n", - "tags": [ - { - "tag": "example", - "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" - } - ] + "shortText": "Override the type of the returned \`data\` field in the response." } }, "@supabase/postgrest-js.PostgrestBuilder.returns": { @@ -23638,13 +23050,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\`.", - "tags": [ - { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\\n" - } - ] + "shortText": "Override the type of the returned \`data\`." } }, "@supabase/postgrest-js.PostgrestBuilder.setHeader": { @@ -23766,8 +23172,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "@supabase/postgrest-js.PostgrestBuilder.throwOnError", "params": [], "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" + "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" } }, "@supabase/postgrest-js.PostgrestClient.constructor": { @@ -23829,7 +23234,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Custom fetch\\n" + "shortText": "Custom fetch" } }, "isOptional": true @@ -23883,7 +23288,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "TableName" }, "comment": { - "shortText": "The table or view name to query\\n" + "shortText": "The table or view name to query" } } ], @@ -23906,7 +23311,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "ViewName" }, "comment": { - "shortText": "The table or view name to query\\n" + "shortText": "The table or view name to query" } } ], @@ -23971,7 +23376,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -24023,7 +23428,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "DynamicSchema" }, "comment": { - "shortText": "The schema to query\\n" + "shortText": "The schema to query" } } ], @@ -24034,8 +23439,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\\n" + "shortText": "Select a schema to query or perform an function (rpc) call.\\n\\nThe schema needs to be on the list of exposed schemas inside Supabase." } }, "@supabase/postgrest-js.PostgrestError.constructor": { @@ -24233,7 +23637,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "AbortSignal" }, "comment": { - "shortText": "The AbortSignal to use for the fetch request\\n" + "shortText": "The AbortSignal to use for the fetch request" } } ], @@ -24291,7 +23695,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The jsonb, array, or range value to filter with\\n" + "shortText": "The jsonb, array, or range value to filter with" } } ], @@ -24348,7 +23752,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The jsonb, array, or range value to filter with\\n" + "shortText": "The jsonb, array, or range value to filter with" } } ], @@ -24408,7 +23812,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The jsonb, array, or range value to filter with\\n" + "shortText": "The jsonb, array, or range value to filter with" } } ], @@ -24465,7 +23869,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The jsonb, array, or range value to filter with\\n" + "shortText": "The jsonb, array, or range value to filter with" } } ], @@ -24510,7 +23914,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "value", "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -24521,8 +23925,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows where \`column\` is equal to \`value\`.", - "text": "To check if the value of \`column\` is NULL, you should use \`.is()\` instead.\\n" + "shortText": "Match only rows where \`column\` is equal to \`value\`.\\n\\nTo check if the value of \`column\` is NULL, you should use \`.is()\` instead." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.explain": { @@ -24541,7 +23944,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned\\n" + "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" } }, { @@ -24552,7 +23955,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on buffer usage\\n" + "shortText": "If \`true\`, include information on buffer usage" } }, { @@ -24572,7 +23975,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`\\n" + "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" } }, { @@ -24583,7 +23986,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning\\n" + "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" } }, { @@ -24594,7 +23997,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query\\n" + "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" } }, { @@ -24605,13 +24008,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on WAL record generation\\n" + "shortText": "If \`true\`, include information on WAL record generation" } } ] }, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -24631,8 +24034,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.", - "text": "You need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.\\n" + "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.filter": { @@ -24758,7 +24160,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\\n" + "shortText": "The value to filter with, following PostgREST syntax" } } ], @@ -24769,8 +24171,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.\\n" + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\\nshould use the specific filter methods wherever possible.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized." }, "altSignatures": [ { @@ -24802,7 +24203,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\\n" + "shortText": "The value to filter with, following PostgREST syntax" } } ], @@ -24813,8 +24214,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.\\n" + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\\nshould use the specific filter methods wherever possible.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized." } } ] @@ -24852,7 +24252,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row['ColumnName']" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -24885,7 +24285,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -24921,7 +24321,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row['ColumnName']" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -24954,7 +24354,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -24990,7 +24390,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The pattern to match with\\n" + "shortText": "The pattern to match with" } } ], @@ -25023,7 +24423,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The pattern to match with\\n" + "shortText": "The pattern to match with" } } ], @@ -25062,7 +24462,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25098,7 +24498,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25137,7 +24537,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25173,7 +24573,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25208,7 +24608,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "array" }, "comment": { - "shortText": "The values array to filter with\\n" + "shortText": "The values array to filter with" } } ], @@ -25237,8 +24637,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, { "name": "value", + "type": { + "type": "intrinsic", + "name": "Object" + }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25249,8 +24653,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows where \`column\` IS \`value\`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\\n\`column\` is NULL by setting \`value\` to \`null\`.\\n\\nFor boolean columns, you can also set \`value\` to \`true\` or \`false\` and it\\nwill behave the same way as \`.eq()\`.\\n" + "shortText": "Match only rows where \`column\` IS \`value\`.\\n\\nFor non-boolean columns, this is only relevant for checking if the value of\\n\`column\` is NULL by setting \`value\` to \`null\`.\\n\\nFor boolean columns, you can also set \`value\` to \`true\` or \`false\` and it\\nwill behave the same way as \`.eq()\`." }, "altSignatures": [ { @@ -25281,7 +24684,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25292,8 +24695,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows where \`column\` IS \`value\`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\\n\`column\` is NULL by setting \`value\` to \`null\`.\\n\\nFor boolean columns, you can also set \`value\` to \`true\` or \`false\` and it\\nwill behave the same way as \`.eq()\`.\\n" + "shortText": "Match only rows where \`column\` IS \`value\`.\\n\\nFor non-boolean columns, this is only relevant for checking if the value of\\n\`column\` is NULL by setting \`value\` to \`null\`.\\n\\nFor boolean columns, you can also set \`value\` to \`true\` or \`false\` and it\\nwill behave the same way as \`.eq()\`." } } ] @@ -25318,7 +24720,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The pattern to match with\\n" + "shortText": "The pattern to match with" } } ], @@ -25351,7 +24753,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The pattern to match with\\n" + "shortText": "The pattern to match with" } } ], @@ -25390,7 +24792,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25426,7 +24828,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25465,7 +24867,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25501,7 +24903,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The patterns to match with\\n" + "shortText": "The patterns to match with" } } ], @@ -25543,7 +24945,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead\\n" + "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" } }, { @@ -25594,7 +24996,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row['ColumnName']" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25627,7 +25029,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25663,7 +25065,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row['ColumnName']" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25696,7 +25098,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25730,7 +25132,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\\nto their filter values\\n" + "shortText": "The object to filter with, with column names as keys mapped\\nto their filter values" } } ], @@ -25761,7 +25163,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\\nto their filter values\\n" + "shortText": "The object to filter with, with column names as keys mapped\\nto their filter values" } } ], @@ -25787,7 +25189,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "number" }, "comment": { - "shortText": "The maximum number of rows that can be affected\\n" + "shortText": "The maximum number of rows that can be affected" } } ], @@ -25805,8 +25207,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.\\n" + "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.neq": { @@ -25825,7 +25226,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "value", "comment": { - "shortText": "The value to filter with\\n" + "shortText": "The value to filter with" } } ], @@ -25869,7 +25270,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row['ColumnName']" }, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\\n" + "shortText": "The value to filter with, following PostgREST syntax" } } ], @@ -25880,8 +25281,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.\\n" + "shortText": "Match only rows which doesn't satisfy the filter.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized." }, "altSignatures": [ { @@ -25913,7 +25313,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "unknown" }, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\\n" + "shortText": "The value to filter with, following PostgREST syntax" } } ], @@ -25924,8 +25324,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.\\n" + "shortText": "Match only rows which doesn't satisfy the filter.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized." } } ] @@ -25956,7 +25355,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Deprecated, use \`referencedTable\` instead\\n" + "shortText": "Deprecated, use \`referencedTable\` instead" } }, { @@ -25984,8 +25383,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, \`filters\` is used as-is and needs to follow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure it's properly sanitized.\\n\\nIt's currently not possible to do an \`.or()\` filter across multiple tables.\\n" + "shortText": "Match only rows which satisfy at least one of the filters.\\n\\nUnlike most filters, \`filters\` is used as-is and needs to follow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure it's properly sanitized.\\n\\nIt's currently not possible to do an \`.or()\` filter across multiple tables." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.order": { @@ -26054,8 +25452,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n" + "shortText": "Order the query result by \`column\`.\\n\\nYou can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query." }, "altSignatures": [ { @@ -26123,8 +25520,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n" + "shortText": "Order the query result by \`column\`.\\n\\nYou can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query." } }, { @@ -26134,9 +25530,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "nameOnly", "name": "ColumnName" - }, - "comment": { - "shortText": "The column to order by" } }, { @@ -26170,10 +25563,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } + "isOptional": true } ], "ret": { @@ -26183,14 +25573,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use \`options.referencedTable\` instead of \`options.foreignTable\`\\n" - } - ] + "shortText": "" } }, { @@ -26200,9 +25583,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "intrinsic", "name": "string" - }, - "comment": { - "shortText": "The column to order by" } }, { @@ -26236,10 +25616,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } + "isOptional": true } ], "ret": { @@ -26249,14 +25626,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use \`options.referencedTable\` instead of \`options.foreignTable\`\\n" - } - ] + "shortText": "" } } ] @@ -26293,7 +25663,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The array or range value to filter with\\n" + "shortText": "The array or range value to filter with" } } ], @@ -26338,7 +25708,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The array or range value to filter with\\n" + "shortText": "The array or range value to filter with" } } ], @@ -26364,14 +25734,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\\n", - "tags": [ - { - "tag": "example", - "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" - } - ] + "shortText": "Override the type of the returned \`data\` field in the response." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.range": { @@ -26410,7 +25773,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead\\n" + "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" } }, { @@ -26461,7 +25824,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26494,7 +25857,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26530,7 +25893,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26563,7 +25926,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26599,7 +25962,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26632,7 +25995,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26668,7 +26031,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26701,7 +26064,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26737,7 +26100,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26770,7 +26133,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The range to filter with\\n" + "shortText": "The range to filter with" } } ], @@ -26796,13 +26159,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\`.", - "tags": [ - { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\\n" - } - ] + "shortText": "Override the type of the returned \`data\`." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.rollback": { @@ -26815,8 +26172,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Rollback the query.", - "text": "\`data\` will still be returned, but the query is not committed.\\n" + "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.select": { @@ -26830,7 +26186,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The columns to retrieve, separated by commas\\n" + "shortText": "The columns to retrieve, separated by commas" } } ], @@ -26841,8 +26197,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.\\n" + "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.setHeader": { @@ -26883,8 +26238,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.\\n" + "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.textSearch": { @@ -26947,7 +26301,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Change how the \`query\` text is interpreted\\n" + "shortText": "Change how the \`query\` text is interpreted" } } ] @@ -27027,7 +26381,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Change how the \`query\` text is interpreted\\n" + "shortText": "Change how the \`query\` text is interpreted" } } ] @@ -27234,8 +26588,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError", "params": [], "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" + "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" } }, "@supabase/postgrest-js.PostgrestQueryBuilder.constructor": { @@ -27351,13 +26704,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count deleted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count deleted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } } ] }, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27368,8 +26721,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.\\n" + "shortText": "Perform a DELETE on the table or view.\\n\\nBy default, deleted rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters." } }, "@supabase/postgrest-js.PostgrestQueryBuilder.insert": { @@ -27382,7 +26734,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row" }, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows.\\n" + "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows." } }, { @@ -27411,14 +26763,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } } ] }, "isOptional": true, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27429,8 +26781,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.\\n" + "shortText": "Perform an INSERT into the table or view.\\n\\nBy default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`." }, "altSignatures": [ { @@ -27445,7 +26796,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows.\\n" + "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows." } }, { @@ -27474,7 +26825,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -27485,14 +26836,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. Only applies for bulk\\ninserts.\\n" + "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. Only applies for bulk\\ninserts." } } ] }, "isOptional": true, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27503,8 +26854,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.\\n" + "shortText": "Perform an INSERT into the table or view.\\n\\nBy default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`." } } ] @@ -27520,7 +26870,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with \`customName:columnName\`\\n" + "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with \`customName:columnName\`" } }, { @@ -27549,7 +26899,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count rows in the table or view.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -27560,13 +26910,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count.\\n" + "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count." } } ] }, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27590,7 +26940,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row" }, "comment": { - "shortText": "The values to update with\\n" + "shortText": "The values to update with" } }, { @@ -27619,13 +26969,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count updated rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count updated rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } } ] }, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27636,8 +26986,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.\\n" + "shortText": "Perform an UPDATE on the table or view.\\n\\nBy default, updated rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters." } }, "@supabase/postgrest-js.PostgrestQueryBuilder.upsert": { @@ -27650,7 +26999,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Row" }, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows.\\n" + "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows." } }, { @@ -27679,7 +27028,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -27690,7 +27039,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows.\\n" + "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows." } }, { @@ -27701,14 +27050,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal.\\n" + "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal." } } ] }, "isOptional": true, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27719,8 +27068,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.\\n" + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.\\n\\nBy default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`." }, "altSignatures": [ { @@ -27735,7 +27083,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows.\\n" + "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows." } }, { @@ -27764,7 +27112,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers.\\n" + "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." } }, { @@ -27775,7 +27123,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. This only applies when\\ninserting new rows, not when merging with existing rows under\\n\`ignoreDuplicates: false\`. This also only applies when doing bulk upserts.\\n" + "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. This only applies when\\ninserting new rows, not when merging with existing rows under\\n\`ignoreDuplicates: false\`. This also only applies when doing bulk upserts." } }, { @@ -27786,7 +27134,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows.\\n" + "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows." } }, { @@ -27797,14 +27145,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal.\\n" + "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal." } } ] }, "isOptional": true, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -27815,8 +27163,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.\\n" + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.\\n\\nBy default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`." } } ] @@ -27975,7 +27322,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "AbortSignal" }, "comment": { - "shortText": "The AbortSignal to use for the fetch request\\n" + "shortText": "The AbortSignal to use for the fetch request" } } ], @@ -28018,7 +27365,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned\\n" + "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" } }, { @@ -28029,7 +27376,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on buffer usage\\n" + "shortText": "If \`true\`, include information on buffer usage" } }, { @@ -28049,7 +27396,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`\\n" + "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" } }, { @@ -28060,7 +27407,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning\\n" + "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" } }, { @@ -28071,7 +27418,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query\\n" + "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" } }, { @@ -28082,13 +27429,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "If \`true\`, include information on WAL record generation\\n" + "shortText": "If \`true\`, include information on WAL record generation" } } ] }, "comment": { - "shortText": "Named parameters\\n" + "shortText": "Named parameters" } } ], @@ -28108,8 +27455,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.", - "text": "You need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.\\n" + "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.geojson": { @@ -28151,7 +27497,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead\\n" + "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" } }, { @@ -28192,7 +27538,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "number" }, "comment": { - "shortText": "The maximum number of rows that can be affected\\n" + "shortText": "The maximum number of rows that can be affected" } } ], @@ -28210,8 +27556,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.\\n" + "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.order": { @@ -28280,8 +27625,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n" + "shortText": "Order the query result by \`column\`.\\n\\nYou can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query." }, "altSignatures": [ { @@ -28349,8 +27693,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n" + "shortText": "Order the query result by \`column\`.\\n\\nYou can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query." } }, { @@ -28360,9 +27703,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "nameOnly", "name": "ColumnName" - }, - "comment": { - "shortText": "The column to order by" } }, { @@ -28396,10 +27736,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } + "isOptional": true } ], "ret": { @@ -28409,14 +27746,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use \`options.referencedTable\` instead of \`options.foreignTable\`\\n" - } - ] + "shortText": "" } }, { @@ -28426,9 +27756,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "intrinsic", "name": "string" - }, - "comment": { - "shortText": "The column to order by" } }, { @@ -28462,10 +27789,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } + "isOptional": true } ], "ret": { @@ -28475,14 +27799,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Order the query result by \`column\`.", - "text": "You can call this method multiple times to order by multiple columns.\\n\\nYou can order referenced tables, but it only affects the ordering of the\\nparent table if you use \`!inner\` in the query.\\n", - "tags": [ - { - "tag": "deprecated", - "text": "Use \`options.referencedTable\` instead of \`options.foreignTable\`\\n" - } - ] + "shortText": "" } } ] @@ -28497,14 +27814,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\\n", - "tags": [ - { - "tag": "example", - "text": "\\n\`\`\`typescript\\n// Merge with existing types (default behavior)\\nconst query = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ custom_field: string }>()\\n\\n// Replace existing types completely\\nconst replaceQuery = supabase\\n .from('users')\\n .select()\\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\\n\`\`\`" - } - ] + "shortText": "Override the type of the returned \`data\` field in the response." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.range": { @@ -28543,7 +27853,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead\\n" + "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" } }, { @@ -28584,13 +27894,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Override the type of the returned \`data\`.", - "tags": [ - { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\\n" - } - ] + "shortText": "Override the type of the returned \`data\`." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.rollback": { @@ -28603,8 +27907,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Rollback the query.", - "text": "\`data\` will still be returned, but the query is not committed.\\n" + "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.select": { @@ -28618,7 +27921,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The columns to retrieve, separated by commas\\n" + "shortText": "The columns to retrieve, separated by commas" } } ], @@ -28629,8 +27932,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.\\n" + "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.setHeader": { @@ -28671,8 +27973,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.\\n" + "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.then": { @@ -28859,8 +28160,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError", "params": [], "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" + "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" } } } @@ -30228,6 +29528,28 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "heartbeatCallback", + "type": { + "type": "function", + "params": [ + { + "name": "status", + "type": { + "type": "nameOnly", + "name": "HeartbeatStatus" + } + } + ], + "ret": { + "type": { + "type": "intrinsic", + "name": "void" + } + } + }, + "isOptional": true + }, { "name": "heartbeatIntervalMs", "type": { @@ -30549,6 +29871,32 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Returns \`true\` is the connection is open." } }, + "@supabase/realtime-js.RealtimeClient.isConnecting": { + "name": "@supabase/realtime-js.RealtimeClient.isConnecting", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + "comment": { + "shortText": "Returns \`true\` if the connection is currently connecting." + } + }, + "@supabase/realtime-js.RealtimeClient.isDisconnecting": { + "name": "@supabase/realtime-js.RealtimeClient.isDisconnecting", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + "comment": { + "shortText": "Returns \`true\` if the connection is currently disconnecting." + } + }, "@supabase/realtime-js.RealtimeClient.log": { "name": "@supabase/realtime-js.RealtimeClient.log", "params": [ @@ -30840,6 +30188,126 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "comment": { "shortText": "Initializes the Presence." } + }, + "@supabase/realtime-js.WebSocketFactory.constructor": { + "name": "@supabase/realtime-js.WebSocketFactory.constructor", + "params": [], + "ret": { + "type": { + "type": "nameOnly", + "name": "WebSocketFactory" + } + } + }, + "@supabase/realtime-js.WebSocketFactory.createWebSocket": { + "name": "@supabase/realtime-js.WebSocketFactory.createWebSocket", + "params": [ + { + "name": "url", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "nameOnly", + "name": "URL" + } + ] + } + }, + { + "name": "protocols", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elemType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + "isOptional": true + } + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "WebSocketLike" + } + } + }, + "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor": { + "name": "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor", + "params": [], + "ret": { + "type": { + "type": "function", + "params": [ + { + "name": "url", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "nameOnly", + "name": "URL" + } + ] + } + }, + { + "name": "protocols", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elemType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + "isOptional": true + } + ], + "ret": { + "type": { + "type": "nameOnly", + "name": "WebSocket" + } + } + } + } + }, + "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported": { + "name": "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "boolean" + } + } } } }, @@ -31084,7 +30552,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`\\n" + "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`" } } ] @@ -31144,8 +30612,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "shortText": "Creates a new Storage bucket" } }, "@supabase/storage-js.index.StorageClient.deleteBucket": { @@ -31158,7 +30625,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\\n" + "shortText": "The unique identifier of the bucket you would like to delete." } } ], @@ -31233,7 +30700,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\\n" + "shortText": "The unique identifier of the bucket you would like to empty." } } ], @@ -31308,7 +30775,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The bucket id to operate on.\\n" + "shortText": "The bucket id to operate on." } } ], @@ -31326,7 +30793,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\\n" + "shortText": "The unique identifier of the bucket you would like to retrieve." } } ], @@ -31604,6 +31071,19 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Retrieves the details of all Storage buckets within an existing project." } }, + "@supabase/storage-js.index.StorageClient.throwOnError": { + "name": "@supabase/storage-js.index.StorageClient.throwOnError", + "params": [], + "ret": { + "type": { + "type": "nameOnly", + "name": "StorageClient" + } + }, + "comment": { + "shortText": "Enable throwing errors instead of returning them." + } + }, "@supabase/storage-js.index.StorageClient.updateBucket": { "name": "@supabase/storage-js.index.StorageClient.updateBucket", "params": [ @@ -31642,7 +31122,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\\n" + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } }, { @@ -31948,7 +31428,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`\\n" + "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`" } } ] @@ -32008,8 +31488,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "shortText": "Creates a new Storage bucket" } }, "@supabase/storage-js.packages/StorageBucketApi.default.deleteBucket": { @@ -32022,7 +31501,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\\n" + "shortText": "The unique identifier of the bucket you would like to delete." } } ], @@ -32097,7 +31576,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\\n" + "shortText": "The unique identifier of the bucket you would like to empty." } } ], @@ -32172,7 +31651,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\\n" + "shortText": "The unique identifier of the bucket you would like to retrieve." } } ], @@ -32450,6 +31929,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Retrieves the details of all Storage buckets within an existing project." } }, + "@supabase/storage-js.packages/StorageBucketApi.default.throwOnError": { + "name": "@supabase/storage-js.packages/StorageBucketApi.default.throwOnError", + "params": [], + "comment": { + "shortText": "Enable throwing errors instead of returning them." + } + }, "@supabase/storage-js.packages/StorageBucketApi.default.updateBucket": { "name": "@supabase/storage-js.packages/StorageBucketApi.default.updateBucket", "params": [ @@ -32488,7 +31974,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\\n" + "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } }, { @@ -32699,7 +32185,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The destination options.\\n" + "shortText": "The destination options." } } ], @@ -32789,7 +32275,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "boolean" }, "comment": { - "shortText": "If set to true, allows the file to be overwritten if it already exists.\\n" + "shortText": "If set to true, allows the file to be overwritten if it already exists." } } ] @@ -32934,8 +32420,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\\n" + "shortText": "Specify the format of the image requested.\\n\\nWhen using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp." } }, { @@ -32999,7 +32484,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Transform the asset before serving it to the client.\\n" + "shortText": "Transform the asset before serving it to the client." } } ] @@ -33115,7 +32600,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\\n" + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." } } ] @@ -33251,8 +32736,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\\n" + "shortText": "Specify the format of the image requested.\\n\\nWhen using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp." } }, { @@ -33316,7 +32800,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Transform the asset before serving it to the client.\\n" + "shortText": "Transform the asset before serving it to the client." } } ] @@ -33385,9 +32869,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "intrinsic", "name": "string" - }, - "comment": { - "shortText": "\\n" } } ], @@ -33496,8 +32977,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\\n" + "shortText": "Specify the format of the image requested.\\n\\nWhen using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp." } }, { @@ -33561,7 +33041,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Transform the asset before serving it to the client.\\n" + "shortText": "Transform the asset before serving it to the client." } } ] @@ -33603,9 +33083,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": { "type": "intrinsic", "name": "string" - }, - "comment": { - "shortText": "\\n" } } ], @@ -33690,13 +33167,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ - { - "tag": "default", - "text": "100\\n" - } - ] + "shortText": "The number of files you want to be returned." } }, { @@ -33754,7 +33225,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search\\n" + "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search" } }, { @@ -33986,7 +33457,327 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Lists all the files within a bucket." + "shortText": "Lists all the files and folders within a path of the bucket." + } + }, + "@supabase/storage-js.packages/StorageFileApi.default.listV2": { + "name": "@supabase/storage-js.packages/StorageFileApi.default.listV2", + "params": [ + { + "name": "options", + "type": { + "type": "object", + "name": "SearchV2Options", + "properties": [ + { + "name": "cursor", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "limit", + "type": { + "type": "intrinsic", + "name": "number" + }, + "isOptional": true + }, + { + "name": "prefix", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "name": "with_delimiter", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + } + ] + }, + "isOptional": true, + "comment": { + "shortText": "search options" + } + }, + { + "name": "parameters", + "type": { + "type": "object", + "name": "FetchParameters", + "properties": [ + { + "name": "signal", + "type": { + "type": "nameOnly", + "name": "AbortSignal" + }, + "isOptional": true, + "comment": { + "shortText": "Pass in an AbortController's signal to cancel the request." + } + } + ] + }, + "isOptional": true + } + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "name": "SearchV2Result", + "properties": [ + { + "name": "folders", + "type": { + "type": "array", + "elemType": { + "type": "object", + "properties": [ + { + "name": "name", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + }, + { + "name": "hasNext", + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "name": "objects", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "FileObject", + "properties": [ + { + "name": "bucket_id", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "buckets", + "type": { + "type": "object", + "name": "Bucket", + "properties": [ + { + "name": "allowed_mime_types", + "type": { + "type": "array", + "elemType": { + "type": "intrinsic", + "name": "string" + } + }, + "isOptional": true + }, + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "file_size_limit", + "type": { + "type": "intrinsic", + "name": "number" + }, + "isOptional": true + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "name", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "owner", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "public", + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "name": "type", + "type": { + "type": "union", + "name": "BucketType", + "subTypes": [ + { + "type": "literal", + "value": "STANDARD" + }, + { + "type": "literal", + "value": "ANALYTICS" + } + ] + }, + "isOptional": true + }, + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "last_accessed_at", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "metadata", + "type": { + "type": "record", + "name": "Record", + "keyType": { + "type": "intrinsic", + "name": "string" + }, + "valueType": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "name": "name", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "owner", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + } + ] + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "StorageError" + } + } + ] + } + ] + } + } + }, + "comment": { + "shortText": "this method signature might change in the future", + "tags": [ + { + "tag": "experimental", + "text": "" + } + ] } }, "@supabase/storage-js.packages/StorageFileApi.default.move": { @@ -34030,7 +33821,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true, "comment": { - "shortText": "The destination options.\\n" + "shortText": "The destination options." } } ], @@ -34108,7 +33899,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [\`'folder/image.png'\`].\\n" + "shortText": "An array of files to delete, including the path and file name. For example [\`'folder/image.png'\`]." } } ], @@ -34322,6 +34113,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Deletes files within the same bucket" } }, + "@supabase/storage-js.packages/StorageFileApi.default.throwOnError": { + "name": "@supabase/storage-js.packages/StorageFileApi.default.throwOnError", + "params": [], + "comment": { + "shortText": "Enable throwing errors instead of returning them." + } + }, "@supabase/storage-js.packages/StorageFileApi.default.toBase64": { "name": "@supabase/storage-js.packages/StorageFileApi.default.toBase64", "params": [ @@ -34401,7 +34199,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "The body of the file to be stored in the bucket.\\n" + "shortText": "The body of the file to be stored in the bucket." } }, { @@ -34592,7 +34390,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "FileBody" }, "comment": { - "shortText": "The body of the file to be stored in the bucket.\\n" + "shortText": "The body of the file to be stored in the bucket." } }, { @@ -34793,7 +34591,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "FileBody" }, "comment": { - "shortText": "The body of the file to be stored in the bucket.\\n" + "shortText": "The body of the file to be stored in the bucket." } }, { diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index 61f111706601d..bbdb896aa8fc2 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -1,18 +1,28 @@ { "openapi": "3.0.0", "paths": { - "/v1/branches/{branch_id}": { + "/v1/branches/{branch_id_or_ref}": { "get": { - "operationId": "v1-get-a-branch-config", - "summary": "Get database branch config", "description": "Fetches configurations of the specified database branch", + "operationId": "v1-get-a-branch-config", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "responses": { @@ -26,20 +36,31 @@ }, "500": { "description": "Failed to retrieve database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get database branch config", + "tags": ["Environments"] }, "patch": { - "operationId": "v1-update-a-branch-config", - "summary": "Update database branch config", "description": "Updates the configuration of the specified database branch", + "operationId": "v1-update-a-branch-config", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "requestBody": { @@ -57,20 +78,31 @@ }, "500": { "description": "Failed to update database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Update database branch config", + "tags": ["Environments"] }, "delete": { - "operationId": "v1-delete-a-branch", - "summary": "Delete a database branch", "description": "Deletes the specified database branch", + "operationId": "v1-delete-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "responses": { @@ -84,22 +116,33 @@ }, "500": { "description": "Failed to delete database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Delete a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/push": { + "/v1/branches/{branch_id_or_ref}/push": { "post": { - "operationId": "v1-push-a-branch", - "summary": "Pushes a database branch", "description": "Pushes the specified database branch", + "operationId": "v1-push-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "requestBody": { @@ -119,22 +162,33 @@ }, "500": { "description": "Failed to push database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Pushes a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/merge": { + "/v1/branches/{branch_id_or_ref}/merge": { "post": { - "operationId": "v1-merge-a-branch", - "summary": "Merges a database branch", "description": "Merges the specified database branch", + "operationId": "v1-merge-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "requestBody": { @@ -154,22 +208,33 @@ }, "500": { "description": "Failed to merge database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Merges a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/reset": { + "/v1/branches/{branch_id_or_ref}/reset": { "post": { - "operationId": "v1-reset-a-branch", - "summary": "Resets a database branch", "description": "Resets the specified database branch", + "operationId": "v1-reset-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } } ], "requestBody": { @@ -189,22 +254,33 @@ }, "500": { "description": "Failed to reset database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Resets a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/diff": { + "/v1/branches/{branch_id_or_ref}/diff": { "get": { - "operationId": "v1-diff-a-branch", - "summary": "[Beta] Diffs a database branch", "description": "Diffs the specified database branch", + "operationId": "v1-diff-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", - "schema": { "format": "uuid", "type": "string" } + "schema": { + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { "type": "string", "format": "uuid", "deprecated": true } + ] + } }, { "name": "included_schemas", @@ -220,15 +296,15 @@ }, "500": { "description": "Failed to diff database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Diffs a database branch", + "tags": ["Environments"] } }, "/v1/projects": { "get": { - "operationId": "v1-list-all-projects", - "summary": "List all projects", "description": "Returns a list of all projects you've previously created.", + "operationId": "v1-list-all-projects", "parameters": [], "responses": { "200": { @@ -243,12 +319,12 @@ } } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all projects", + "tags": ["Projects"] }, "post": { "operationId": "v1-create-a-project", - "summary": "Create a project", "parameters": [], "requestBody": { "required": true, @@ -264,15 +340,15 @@ } } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Create a project", + "tags": ["Projects"] } }, "/v1/organizations": { "get": { - "operationId": "v1-list-all-organizations", - "summary": "List all organizations", "description": "Returns a list of organizations that you currently belong to.", + "operationId": "v1-list-all-organizations", "parameters": [], "responses": { "200": { @@ -288,12 +364,12 @@ }, "500": { "description": "Unexpected error listing organizations" } }, - "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all organizations", + "tags": ["Organizations"] }, "post": { "operationId": "v1-create-an-organization", - "summary": "Create an organization", "parameters": [], "requestBody": { "required": true, @@ -314,14 +390,14 @@ }, "500": { "description": "Unexpected error creating an organization" } }, - "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Create an organization", + "tags": ["Organizations"] } }, "/v1/oauth/authorize": { "get": { "operationId": "v1-authorize-user", - "summary": "[Beta] Authorize user through oauth", "parameters": [ { "name": "client_id", @@ -333,7 +409,7 @@ "name": "response_type", "required": true, "in": "query", - "schema": { "enum": ["code", "token", "id_token token"], "type": "string" } + "schema": { "type": "string", "enum": ["code", "token", "id_token token"] } }, { "name": "redirect_uri", @@ -359,7 +435,7 @@ "name": "code_challenge_method", "required": false, "in": "query", - "schema": { "enum": ["plain", "sha256", "S256"], "type": "string" } + "schema": { "type": "string", "enum": ["plain", "sha256", "S256"] } }, { "name": "organization_slug", @@ -373,18 +449,18 @@ "required": false, "in": "query", "description": "Resource indicator for MCP (Model Context Protocol) clients", - "schema": { "enum": ["https://api.supabase.io/mcp"], "type": "string" } + "schema": { "type": "string", "enum": ["https://api.supabase.io/mcp"] } } ], "responses": { "204": { "description": "" } }, - "tags": ["OAuth"], - "security": [{ "oauth2": ["read"] }] + "security": [{ "oauth2": ["read"] }], + "summary": "[Beta] Authorize user through oauth", + "tags": ["OAuth"] } }, "/v1/oauth/token": { "post": { "operationId": "v1-exchange-oauth-token", - "summary": "[Beta] Exchange auth code for user's access and refresh token", "parameters": [], "requestBody": { "required": true, @@ -404,14 +480,14 @@ } } }, - "tags": ["OAuth"], - "security": [{ "oauth2": ["write"] }] + "security": [{ "oauth2": ["write"] }], + "summary": "[Beta] Exchange auth code for user's access and refresh token", + "tags": ["OAuth"] } }, "/v1/oauth/revoke": { "post": { "operationId": "v1-revoke-token", - "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", "parameters": [], "requestBody": { "required": true, @@ -422,16 +498,15 @@ } }, "responses": { "204": { "description": "" } }, - "tags": ["OAuth"], - "security": [{ "oauth2": ["write"] }] + "security": [{ "oauth2": ["write"] }], + "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", + "tags": ["OAuth"] } }, "/v1/oauth/authorize/project-claim": { "get": { - "operationId": "v1-oauth-authorize-project-claim", - "x-internal": true, - "summary": "Authorize user through oauth and claim a project", "description": "Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.", + "operationId": "v1-oauth-authorize-project-claim", "parameters": [ { "name": "project_ref", @@ -450,7 +525,7 @@ "name": "response_type", "required": true, "in": "query", - "schema": { "enum": ["code", "token", "id_token token"], "type": "string" } + "schema": { "type": "string", "enum": ["code", "token", "id_token token"] } }, { "name": "redirect_uri", @@ -475,18 +550,19 @@ "name": "code_challenge_method", "required": false, "in": "query", - "schema": { "enum": ["plain", "sha256", "S256"], "type": "string" } + "schema": { "type": "string", "enum": ["plain", "sha256", "S256"] } } ], "responses": { "204": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Authorize user through oauth and claim a project", "tags": ["OAuth"], - "security": [{ "bearer": [] }] + "x-internal": true } }, "/v1/snippets": { "get": { "operationId": "v1-list-all-snippets", - "summary": "Lists SQL snippets for the logged in user", "parameters": [ { "name": "project_ref", @@ -524,14 +600,14 @@ }, "500": { "description": "Failed to list user's SQL snippets" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists SQL snippets for the logged in user", + "tags": ["Database"] } }, "/v1/snippets/{id}": { "get": { "operationId": "v1-get-a-snippet", - "summary": "Gets a specific SQL snippet", "parameters": [ { "name": "id", @@ -549,14 +625,14 @@ }, "500": { "description": "Failed to retrieve SQL snippet" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets a specific SQL snippet", + "tags": ["Database"] } }, "/v1/projects/{ref}/api-keys": { "get": { "operationId": "v1-get-project-api-keys", - "summary": "Get project api keys", "parameters": [ { "name": "ref", @@ -587,12 +663,12 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get project api keys", + "tags": ["Secrets"] }, "post": { "operationId": "v1-create-project-api-key", - "summary": "Creates a new API key for the project", "parameters": [ { "name": "ref", @@ -624,14 +700,14 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Creates a new API key for the project", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/api-keys/legacy": { "get": { "operationId": "v1-get-project-legacy-api-keys", - "summary": "Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -652,12 +728,12 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Secrets"] }, "put": { "operationId": "v1-update-project-legacy-api-keys", - "summary": "Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -685,14 +761,14 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/api-keys/{id}": { "patch": { "operationId": "v1-update-project-api-key", - "summary": "Updates an API key for the project", "parameters": [ { "name": "ref", @@ -730,12 +806,12 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates an API key for the project", + "tags": ["Secrets"] }, "get": { "operationId": "v1-get-project-api-key", - "summary": "Get API key", "parameters": [ { "name": "ref", @@ -767,12 +843,12 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get API key", + "tags": ["Secrets"] }, "delete": { "operationId": "v1-delete-project-api-key", - "summary": "Deletes an API key for the project", "parameters": [ { "name": "ref", @@ -812,15 +888,15 @@ }, "403": { "description": "" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Deletes an API key for the project", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/branches": { "get": { - "operationId": "v1-list-all-branches", - "summary": "List all database branches", "description": "Returns all database branches of the specified project.", + "operationId": "v1-list-all-branches", "parameters": [ { "name": "ref", @@ -845,13 +921,13 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve database branches" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all database branches", + "tags": ["Environments"] }, "post": { - "operationId": "v1-create-a-branch", - "summary": "Create a database branch", "description": "Creates a database branch from the specified project.", + "operationId": "v1-create-a-branch", "parameters": [ { "name": "ref", @@ -877,13 +953,13 @@ "403": { "description": "" }, "500": { "description": "Failed to create database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Create a database branch", + "tags": ["Environments"] }, "delete": { - "operationId": "v1-disable-preview-branching", - "summary": "Disables preview branching", "description": "Disables preview branching for the specified project", + "operationId": "v1-disable-preview-branching", "parameters": [ { "name": "ref", @@ -898,15 +974,15 @@ "403": { "description": "" }, "500": { "description": "Failed to disable preview branching" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Disables preview branching", + "tags": ["Environments"] } }, "/v1/projects/{ref}/branches/{name}": { "get": { - "operationId": "v1-get-a-branch", - "summary": "Get a database branch", "description": "Fetches the specified database branch by its name.", + "operationId": "v1-get-a-branch", "parameters": [ { "name": "ref", @@ -927,14 +1003,14 @@ "403": { "description": "" }, "500": { "description": "Failed to fetch database branch" } }, - "tags": ["Environments"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get a database branch", + "tags": ["Environments"] } }, "/v1/projects/{ref}/custom-hostname": { "get": { "operationId": "v1-get-hostname-config", - "summary": "[Beta] Gets project's custom hostname config", "parameters": [ { "name": "ref", @@ -956,12 +1032,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's custom hostname config" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets project's custom hostname config", + "tags": ["Domains"] }, "delete": { "operationId": "v1-Delete hostname config", - "summary": "[Beta] Deletes a project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -976,14 +1052,14 @@ "403": { "description": "" }, "500": { "description": "Failed to delete project custom hostname configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Deletes a project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/initialize": { "post": { "operationId": "v1-update-hostname-config", - "summary": "[Beta] Updates project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -1013,14 +1089,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project custom hostname configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Updates project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/reverify": { "post": { "operationId": "v1-verify-dns-config", - "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -1042,14 +1118,14 @@ "403": { "description": "" }, "500": { "description": "Failed to verify project custom hostname configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/activate": { "post": { "operationId": "v1-activate-custom-hostname", - "summary": "[Beta] Activates a custom hostname for a project.", "parameters": [ { "name": "ref", @@ -1071,14 +1147,14 @@ "403": { "description": "" }, "500": { "description": "Failed to activate project custom hostname configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Activates a custom hostname for a project.", + "tags": ["Domains"] } }, "/v1/projects/{ref}/network-bans/retrieve": { "post": { "operationId": "v1-list-all-network-bans", - "summary": "[Beta] Gets project's network bans", "parameters": [ { "name": "ref", @@ -1100,14 +1176,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's network bans" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets project's network bans", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-bans/retrieve/enriched": { "post": { "operationId": "v1-list-all-network-bans-enriched", - "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", "parameters": [ { "name": "ref", @@ -1129,14 +1205,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's enriched network bans" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-bans": { "delete": { "operationId": "v1-delete-network-bans", - "summary": "[Beta] Remove network bans.", "parameters": [ { "name": "ref", @@ -1159,14 +1235,14 @@ "403": { "description": "" }, "500": { "description": "Failed to remove network bans." } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Remove network bans.", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-restrictions": { "get": { "operationId": "v1-get-network-restrictions", - "summary": "[Beta] Gets project's network restrictions", "parameters": [ { "name": "ref", @@ -1188,14 +1264,49 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's network restrictions" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets project's network restrictions", + "tags": ["Projects"] + }, + "patch": { + "operationId": "v1-patch-network-restrictions", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/NetworkRestrictionsPatchRequest" } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/NetworkRestrictionsV2Response" } + } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to update project network restrictions" } + }, + "security": [{ "bearer": [] }], + "summary": "[Alpha] Updates project's network restrictions by adding or removing CIDRs", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-restrictions/apply": { "post": { "operationId": "v1-update-network-restrictions", - "summary": "[Beta] Updates project's network restrictions", "parameters": [ { "name": "ref", @@ -1225,14 +1336,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project network restrictions" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Updates project's network restrictions", + "tags": ["Projects"] } }, "/v1/projects/{ref}/pgsodium": { "get": { "operationId": "v1-get-pgsodium-config", - "summary": "[Beta] Gets project's pgsodium config", "parameters": [ { "name": "ref", @@ -1254,12 +1365,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's pgsodium config" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets project's pgsodium config", + "tags": ["Secrets"] }, "put": { "operationId": "v1-update-pgsodium-config", - "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", "parameters": [ { "name": "ref", @@ -1289,14 +1400,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's pgsodium config" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/postgrest": { "get": { "operationId": "v1-get-postgrest-service-config", - "summary": "Gets project's postgrest config", "parameters": [ { "name": "ref", @@ -1318,12 +1429,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's postgrest config" } }, - "tags": ["Rest"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's postgrest config", + "tags": ["Rest"] }, "patch": { "operationId": "v1-update-postgrest-service-config", - "summary": "Updates project's postgrest config", "parameters": [ { "name": "ref", @@ -1353,14 +1464,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's postgrest config" } }, - "tags": ["Rest"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates project's postgrest config", + "tags": ["Rest"] } }, "/v1/projects/{ref}": { "get": { "operationId": "v1-get-project", - "summary": "Gets a specific project that belongs to the authenticated user", "parameters": [ { "name": "ref", @@ -1382,12 +1493,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets a specific project that belongs to the authenticated user", + "tags": ["Projects"] }, "delete": { "operationId": "v1-delete-a-project", - "summary": "Deletes the given project", "parameters": [ { "name": "ref", @@ -1408,15 +1519,15 @@ }, "403": { "description": "" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Deletes the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/secrets": { "get": { - "operationId": "v1-list-all-secrets", - "summary": "List all secrets", "description": "Returns all secrets you've previously added to the specified project.", + "operationId": "v1-list-all-secrets", "parameters": [ { "name": "ref", @@ -1441,13 +1552,13 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's secrets" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all secrets", + "tags": ["Secrets"] }, "post": { - "operationId": "v1-bulk-create-secrets", - "summary": "Bulk create secrets", "description": "Creates multiple secrets and adds them to the specified project.", + "operationId": "v1-bulk-create-secrets", "parameters": [ { "name": "ref", @@ -1468,13 +1579,13 @@ "403": { "description": "" }, "500": { "description": "Failed to create project's secrets" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Bulk create secrets", + "tags": ["Secrets"] }, "delete": { - "operationId": "v1-bulk-delete-secrets", - "summary": "Bulk delete secrets", "description": "Deletes all secrets with the given names from the specified project", + "operationId": "v1-bulk-delete-secrets", "parameters": [ { "name": "ref", @@ -1495,14 +1606,14 @@ "403": { "description": "" }, "500": { "description": "Failed to delete secrets with given names" } }, - "tags": ["Secrets"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Bulk delete secrets", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/ssl-enforcement": { "get": { "operationId": "v1-get-ssl-enforcement-config", - "summary": "[Beta] Get project's SSL enforcement configuration.", "parameters": [ { "name": "ref", @@ -1524,12 +1635,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's SSL enforcement config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Get project's SSL enforcement configuration.", + "tags": ["Database"] }, "put": { "operationId": "v1-update-ssl-enforcement-config", - "summary": "[Beta] Update project's SSL enforcement configuration.", "parameters": [ { "name": "ref", @@ -1559,15 +1670,15 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's SSL enforcement configuration." } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Update project's SSL enforcement configuration.", + "tags": ["Database"] } }, "/v1/projects/{ref}/types/typescript": { "get": { - "operationId": "v1-generate-typescript-types", - "summary": "Generate TypeScript types", "description": "Returns the TypeScript types of your schema for use with supabase-js.", + "operationId": "v1-generate-typescript-types", "parameters": [ { "name": "included_schemas", @@ -1595,14 +1706,14 @@ "403": { "description": "" }, "500": { "description": "Failed to generate TypeScript types" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Generate TypeScript types", + "tags": ["Database"] } }, "/v1/projects/{ref}/vanity-subdomain": { "get": { "operationId": "v1-get-vanity-subdomain-config", - "summary": "[Beta] Gets current vanity subdomain config", "parameters": [ { "name": "ref", @@ -1624,12 +1735,12 @@ "403": { "description": "" }, "500": { "description": "Failed to get project vanity subdomain configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets current vanity subdomain config", + "tags": ["Domains"] }, "delete": { "operationId": "v1-deactivate-vanity-subdomain-config", - "summary": "[Beta] Deletes a project's vanity subdomain configuration", "parameters": [ { "name": "ref", @@ -1644,14 +1755,14 @@ "403": { "description": "" }, "500": { "description": "Failed to delete project vanity subdomain configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Deletes a project's vanity subdomain configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/vanity-subdomain/check-availability": { "post": { "operationId": "v1-check-vanity-subdomain-availability", - "summary": "[Beta] Checks vanity subdomain availability", "parameters": [ { "name": "ref", @@ -1679,14 +1790,14 @@ "403": { "description": "" }, "500": { "description": "Failed to check project vanity subdomain configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Checks vanity subdomain availability", + "tags": ["Domains"] } }, "/v1/projects/{ref}/vanity-subdomain/activate": { "post": { "operationId": "v1-activate-vanity-subdomain-config", - "summary": "[Beta] Activates a vanity subdomain for a project.", "parameters": [ { "name": "ref", @@ -1714,14 +1825,14 @@ "403": { "description": "" }, "500": { "description": "Failed to activate project vanity subdomain configuration" } }, - "tags": ["Domains"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Activates a vanity subdomain for a project.", + "tags": ["Domains"] } }, "/v1/projects/{ref}/upgrade": { "post": { "operationId": "v1-upgrade-postgres-version", - "summary": "[Beta] Upgrades the project's Postgres version", "parameters": [ { "name": "ref", @@ -1749,14 +1860,14 @@ "403": { "description": "" }, "500": { "description": "Failed to initiate project upgrade" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Upgrades the project's Postgres version", + "tags": ["Projects"] } }, "/v1/projects/{ref}/upgrade/eligibility": { "get": { "operationId": "v1-get-postgres-upgrade-eligibility", - "summary": "[Beta] Returns the project's eligibility for upgrades", "parameters": [ { "name": "ref", @@ -1778,14 +1889,14 @@ "403": { "description": "" }, "500": { "description": "Failed to determine project upgrade eligibility" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Returns the project's eligibility for upgrades", + "tags": ["Projects"] } }, "/v1/projects/{ref}/upgrade/status": { "get": { "operationId": "v1-get-postgres-upgrade-status", - "summary": "[Beta] Gets the latest status of the project's upgrade", "parameters": [ { "name": "ref", @@ -1813,14 +1924,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project upgrade status" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Gets the latest status of the project's upgrade", + "tags": ["Projects"] } }, "/v1/projects/{ref}/readonly": { "get": { "operationId": "v1-get-readonly-mode-status", - "summary": "Returns project's readonly mode status", "parameters": [ { "name": "ref", @@ -1842,14 +1953,14 @@ "403": { "description": "" }, "500": { "description": "Failed to get project readonly mode status" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Returns project's readonly mode status", + "tags": ["Database"] } }, "/v1/projects/{ref}/readonly/temporary-disable": { "post": { "operationId": "v1-disable-readonly-mode-temporarily", - "summary": "Disables project's readonly mode for the next 15 minutes", "parameters": [ { "name": "ref", @@ -1864,14 +1975,14 @@ "403": { "description": "" }, "500": { "description": "Failed to disable project's readonly mode" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Disables project's readonly mode for the next 15 minutes", + "tags": ["Database"] } }, "/v1/projects/{ref}/read-replicas/setup": { "post": { "operationId": "v1-setup-a-read-replica", - "summary": "[Beta] Set up a read replica", "parameters": [ { "name": "ref", @@ -1894,14 +2005,14 @@ "403": { "description": "" }, "500": { "description": "Failed to set up read replica" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Set up a read replica", + "tags": ["Database"] } }, "/v1/projects/{ref}/read-replicas/remove": { "post": { "operationId": "v1-remove-a-read-replica", - "summary": "[Beta] Remove a read replica", "parameters": [ { "name": "ref", @@ -1924,14 +2035,14 @@ "403": { "description": "" }, "500": { "description": "Failed to remove read replica" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] Remove a read replica", + "tags": ["Database"] } }, "/v1/projects/{ref}/health": { "get": { "operationId": "v1-get-services-health", - "summary": "Gets project's service health status", "parameters": [ { "name": "ref", @@ -1948,7 +2059,16 @@ "type": "array", "items": { "type": "string", - "enum": ["auth", "db", "pooler", "realtime", "rest", "storage"] + "enum": [ + "auth", + "db", + "db_postgres_user", + "pooler", + "realtime", + "rest", + "storage", + "pg_bouncer" + ] } } }, @@ -1974,14 +2094,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's service health status" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's service health status", + "tags": ["Projects"] } }, "/v1/projects/{ref}/config/auth/signing-keys/legacy": { "post": { "operationId": "v1-create-legacy-signing-key", - "summary": "Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -2002,12 +2122,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-legacy-signing-key", - "summary": "Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -2028,14 +2148,14 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/signing-keys": { "post": { "operationId": "v1-create-project-signing-key", - "summary": "Create a new signing key for the project in standby status", "parameters": [ { "name": "ref", @@ -2064,12 +2184,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Create a new signing key for the project in standby status", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-project-signing-keys", - "summary": "List all signing keys for the project", "parameters": [ { "name": "ref", @@ -2090,14 +2210,14 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all signing keys for the project", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/signing-keys/{id}": { "get": { "operationId": "v1-get-project-signing-key", - "summary": "Get information about a signing key", "parameters": [ { "name": "id", @@ -2124,12 +2244,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get information about a signing key", + "tags": ["Auth"] }, "delete": { "operationId": "v1-remove-project-signing-key", - "summary": "Remove a signing key from a project. Only possible if the key has been in revoked status for a while.", "parameters": [ { "name": "id", @@ -2156,12 +2276,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Remove a signing key from a project. Only possible if the key has been in revoked status for a while.", + "tags": ["Auth"] }, "patch": { "operationId": "v1-update-project-signing-key", - "summary": "Update a signing key, mainly its status", "parameters": [ { "name": "id", @@ -2196,14 +2316,14 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Update a signing key, mainly its status", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/storage": { "get": { "operationId": "v1-get-storage-config", - "summary": "Gets project's storage config", "parameters": [ { "name": "ref", @@ -2225,12 +2345,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's storage config" } }, - "tags": ["Storage"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's storage config", + "tags": ["Storage"] }, "patch": { "operationId": "v1-update-storage-config", - "summary": "Updates project's storage config", "parameters": [ { "name": "ref", @@ -2253,14 +2373,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's storage config" } }, - "tags": ["Storage"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates project's storage config", + "tags": ["Storage"] } }, "/v1/projects/{ref}/config/database/postgres": { "get": { "operationId": "v1-get-postgres-config", - "summary": "Gets project's Postgres config", "parameters": [ { "name": "ref", @@ -2282,12 +2402,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's Postgres config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's Postgres config", + "tags": ["Database"] }, "put": { "operationId": "v1-update-postgres-config", - "summary": "Updates project's Postgres config", "parameters": [ { "name": "ref", @@ -2317,14 +2437,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's Postgres config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates project's Postgres config", + "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pgbouncer": { "get": { "operationId": "v1-get-project-pgbouncer-config", - "summary": "Get project's pgbouncer config", "parameters": [ { "name": "ref", @@ -2346,13 +2466,13 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's pgbouncer config" } }, + "summary": "Get project's pgbouncer config", "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pooler": { "get": { "operationId": "v1-get-pooler-config", - "summary": "Gets project's supavisor config", "parameters": [ { "name": "ref", @@ -2374,14 +2494,15 @@ } } }, + "403": { "description": "" }, "500": { "description": "Failed to retrieve project's supavisor config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's supavisor config", + "tags": ["Database"] }, "patch": { "operationId": "v1-update-pooler-config", - "summary": "Updates project's supavisor config", "parameters": [ { "name": "ref", @@ -2411,14 +2532,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's supavisor config" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates project's supavisor config", + "tags": ["Database"] } }, "/v1/projects/{ref}/config/auth": { "get": { "operationId": "v1-get-auth-service-config", - "summary": "Gets project's auth config", "parameters": [ { "name": "ref", @@ -2440,12 +2561,12 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's auth config" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's auth config", + "tags": ["Auth"] }, "patch": { "operationId": "v1-update-auth-service-config", - "summary": "Updates a project's auth config", "parameters": [ { "name": "ref", @@ -2475,14 +2596,14 @@ "403": { "description": "" }, "500": { "description": "Failed to update project's auth config" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates a project's auth config", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/third-party-auth": { "post": { "operationId": "v1-create-project-tpa-integration", - "summary": "Creates a new third-party auth integration", "parameters": [ { "name": "ref", @@ -2509,12 +2630,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Creates a new third-party auth integration", + "tags": ["Auth"] }, "get": { "operationId": "v1-list-project-tpa-integrations", - "summary": "Lists all third-party auth integrations", "parameters": [ { "name": "ref", @@ -2538,14 +2659,14 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists all third-party auth integrations", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}": { "delete": { "operationId": "v1-delete-project-tpa-integration", - "summary": "Removes a third-party auth integration", "parameters": [ { "name": "ref", @@ -2570,12 +2691,12 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Removes a third-party auth integration", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-project-tpa-integration", - "summary": "Get a third-party integration", "parameters": [ { "name": "ref", @@ -2600,14 +2721,14 @@ }, "403": { "description": "" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get a third-party integration", + "tags": ["Auth"] } }, "/v1/projects/{ref}/pause": { "post": { "operationId": "v1-pause-a-project", - "summary": "Pauses the given project", "parameters": [ { "name": "ref", @@ -2618,14 +2739,14 @@ } ], "responses": { "200": { "description": "" }, "403": { "description": "" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Pauses the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/restore": { "get": { "operationId": "v1-list-available-restore-versions", - "summary": "Lists available restore versions for the given project", "parameters": [ { "name": "ref", @@ -2648,12 +2769,12 @@ }, "403": { "description": "" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists available restore versions for the given project", + "tags": ["Projects"] }, "post": { "operationId": "v1-restore-a-project", - "summary": "Restores the given project", "parameters": [ { "name": "ref", @@ -2664,14 +2785,14 @@ } ], "responses": { "200": { "description": "" }, "403": { "description": "" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Restores the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/restore/cancel": { "post": { "operationId": "v1-cancel-a-project-restoration", - "summary": "Cancels the given project restoration", "parameters": [ { "name": "ref", @@ -2682,14 +2803,14 @@ } ], "responses": { "200": { "description": "" }, "403": { "description": "" } }, - "tags": ["Projects"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Cancels the given project restoration", + "tags": ["Projects"] } }, "/v1/projects/{ref}/billing/addons": { "get": { "operationId": "v1-list-project-addons", - "summary": "Lists project addons", "parameters": [ { "name": "ref", @@ -2711,12 +2832,12 @@ "403": { "description": "" }, "500": { "description": "Failed to list project addons" } }, - "tags": ["Billing"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists project addons", + "tags": ["Billing"] }, "patch": { "operationId": "v1-apply-project-addon", - "summary": "Applies project addon", "parameters": [ { "name": "ref", @@ -2739,14 +2860,14 @@ "403": { "description": "" }, "500": { "description": "Failed to apply project addon" } }, - "tags": ["Billing"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Applies project addon", + "tags": ["Billing"] } }, "/v1/projects/{ref}/billing/addons/{addon_variant}": { "delete": { "operationId": "v1-remove-project-addon", - "summary": "Removes project addon", "parameters": [ { "name": "ref", @@ -2759,35 +2880,36 @@ "name": "addon_variant", "required": true, "in": "path", - "oneOf": [ - { - "type": "string", - "enum": [ - "ci_micro", - "ci_small", - "ci_medium", - "ci_large", - "ci_xlarge", - "ci_2xlarge", - "ci_4xlarge", - "ci_8xlarge", - "ci_12xlarge", - "ci_16xlarge", - "ci_24xlarge", - "ci_24xlarge_optimized_cpu", - "ci_24xlarge_optimized_memory", - "ci_24xlarge_high_memory", - "ci_48xlarge", - "ci_48xlarge_optimized_cpu", - "ci_48xlarge_optimized_memory", - "ci_48xlarge_high_memory" - ] - }, - { "type": "string", "enum": ["cd_default"] }, - { "type": "string", "enum": ["pitr_7", "pitr_14", "pitr_28"] }, - { "type": "string", "enum": ["ipv4_default"] } - ], - "schema": {} + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ci_micro", + "ci_small", + "ci_medium", + "ci_large", + "ci_xlarge", + "ci_2xlarge", + "ci_4xlarge", + "ci_8xlarge", + "ci_12xlarge", + "ci_16xlarge", + "ci_24xlarge", + "ci_24xlarge_optimized_cpu", + "ci_24xlarge_optimized_memory", + "ci_24xlarge_high_memory", + "ci_48xlarge", + "ci_48xlarge_optimized_cpu", + "ci_48xlarge_optimized_memory", + "ci_48xlarge_high_memory" + ] + }, + { "type": "string", "enum": ["cd_default"] }, + { "type": "string", "enum": ["pitr_7", "pitr_14", "pitr_28"] }, + { "type": "string", "enum": ["ipv4_default"] } + ] + } } ], "responses": { @@ -2795,15 +2917,14 @@ "403": { "description": "" }, "500": { "description": "Failed to remove project addon" } }, - "tags": ["Billing"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Removes project addon", + "tags": ["Billing"] } }, "/v1/projects/{ref}/claim-token": { "get": { "operationId": "v1-get-project-claim-token", - "x-internal": true, - "summary": "Gets project claim token", "parameters": [ { "name": "ref", @@ -2824,13 +2945,13 @@ }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Gets project claim token", "tags": ["Projects"], - "security": [{ "bearer": [] }] + "x-internal": true }, "post": { "operationId": "v1-create-project-claim-token", - "x-internal": true, - "summary": "Creates project claim token", "parameters": [ { "name": "ref", @@ -2851,13 +2972,13 @@ }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Creates project claim token", "tags": ["Projects"], - "security": [{ "bearer": [] }] + "x-internal": true }, "delete": { "operationId": "v1-delete-project-claim-token", - "x-internal": true, - "summary": "Revokes project claim token", "parameters": [ { "name": "ref", @@ -2868,16 +2989,17 @@ } ], "responses": { "204": { "description": "" }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Revokes project claim token", "tags": ["Projects"], - "security": [{ "bearer": [] }] + "x-internal": true } }, "/v1/projects/{ref}/advisors/performance": { "get": { - "operationId": "v1-get-performance-advisors", - "summary": "Gets project performance advisors.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-performance-advisors", "parameters": [ { "name": "ref", @@ -2898,16 +3020,16 @@ }, "403": { "description": "" } }, - "tags": ["Advisors"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project performance advisors.", + "tags": ["Advisors"] } }, "/v1/projects/{ref}/advisors/security": { "get": { - "operationId": "v1-get-security-advisors", - "summary": "Gets project security advisors.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-security-advisors", "parameters": [ { "name": "ref", @@ -2920,7 +3042,7 @@ "name": "lint_type", "required": false, "in": "query", - "schema": { "enum": ["sql"], "type": "string" } + "schema": { "type": "string", "enum": ["sql"] } } ], "responses": { @@ -2934,15 +3056,15 @@ }, "403": { "description": "" } }, - "tags": ["Advisors"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project security advisors.", + "tags": ["Advisors"] } }, "/v1/projects/{ref}/analytics/endpoints/logs.all": { "get": { - "operationId": "v1-get-project-logs", - "summary": "Gets project's logs", "description": "Executes a SQL query on the project's logs.\n\nEither the 'iso_timestamp_start' and 'iso_timestamp_end' parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n", + "operationId": "v1-get-project-logs", "parameters": [ { "name": "ref", @@ -2974,14 +3096,14 @@ }, "403": { "description": "" } }, - "tags": ["Analytics"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's logs", + "tags": ["Analytics"] } }, "/v1/projects/{ref}/analytics/endpoints/usage.api-counts": { "get": { "operationId": "v1-get-project-usage-api-count", - "summary": "Gets project's usage api counts", "parameters": [ { "name": "ref", @@ -2995,8 +3117,8 @@ "required": false, "in": "query", "schema": { - "enum": ["15min", "30min", "1hr", "3hr", "1day", "3day", "7day"], - "type": "string" + "type": "string", + "enum": ["15min", "30min", "1hr", "3hr", "1day", "3day", "7day"] } } ], @@ -3004,20 +3126,22 @@ "200": { "description": "", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } } + "application/json": { + "schema": { "$ref": "#/components/schemas/V1GetUsageApiCountResponse" } + } } }, "403": { "description": "" }, "500": { "description": "Failed to get project's usage api counts" } }, - "tags": ["Analytics"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's usage api counts", + "tags": ["Analytics"] } }, "/v1/projects/{ref}/analytics/endpoints/usage.api-requests-count": { "get": { "operationId": "v1-get-project-usage-request-count", - "summary": "Gets project's usage api requests count", "parameters": [ { "name": "ref", @@ -3031,20 +3155,119 @@ "200": { "description": "", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } } + "application/json": { + "schema": { "$ref": "#/components/schemas/V1GetUsageApiRequestsCountResponse" } + } } }, + "403": { "description": "" }, "500": { "description": "Failed to get project's usage api requests count" } }, - "tags": ["Analytics"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets project's usage api requests count", + "tags": ["Analytics"] + } + }, + "/v1/projects/{ref}/analytics/endpoints/functions.combined-stats": { + "get": { + "operationId": "v1-get-project-function-combined-stats", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + }, + { + "name": "interval", + "required": true, + "in": "query", + "schema": { "type": "string", "enum": ["15min", "1hr", "3hr", "1day"] } + }, + { "name": "function_id", "required": true, "in": "query", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsResponse" } } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to get project's function combined statistics" } + }, + "security": [{ "bearer": [] }], + "summary": "Gets a project's function combined statistics", + "tags": ["Analytics"] + } + }, + "/v1/projects/{ref}/cli/login-role": { + "post": { + "operationId": "v1-create-login-role", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoleBody" } } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/CreateRoleResponse" } + } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to create login role" } + }, + "security": [{ "bearer": [] }], + "summary": "[Beta] Create a login role for CLI with temporary password", + "tags": ["Database"] + }, + "delete": { + "operationId": "v1-delete-login-roles", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/DeleteRolesResponse" } + } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to delete login roles" } + }, + "security": [{ "bearer": [] }], + "summary": "[Beta] Delete existing login roles used by CLI", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/migrations": { "get": { - "operationId": "v1-list-migration-history", - "summary": "[Beta] List applied migration versions", "description": "Only available to selected partner OAuth apps", + "operationId": "v1-list-migration-history", "parameters": [ { "name": "ref", @@ -3066,13 +3289,49 @@ "403": { "description": "" }, "500": { "description": "Failed to list database migrations" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "[Beta] List applied migration versions", + "tags": ["Database"] }, "post": { + "description": "Only available to selected partner OAuth apps", "operationId": "v1-apply-a-migration", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + }, + { + "name": "Idempotency-Key", + "required": false, + "in": "header", + "description": "A unique key to ensure the same migration is tracked only once.", + "schema": { "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V1CreateMigrationBody" } + } + } + }, + "responses": { + "200": { "description": "" }, + "403": { "description": "" }, + "500": { "description": "Failed to apply database migration" } + }, + "security": [{ "bearer": [] }], "summary": "[Beta] Apply a database migration", + "tags": ["Database"] + }, + "put": { "description": "Only available to selected partner OAuth apps", + "operationId": "v1-upsert-a-migration", "parameters": [ { "name": "ref", @@ -3093,22 +3352,130 @@ "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V1CreateMigrationBody" } + "schema": { "$ref": "#/components/schemas/V1UpsertMigrationBody" } } } }, "responses": { "200": { "description": "" }, "403": { "description": "" }, - "500": { "description": "Failed to apply database migration" } + "500": { "description": "Failed to upsert database migration" } + }, + "security": [{ "bearer": [] }], + "summary": "[Beta] Upsert a database migration without applying", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/query": { + "post": { + "operationId": "v1-run-a-query", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/V1RunQueryBody" } } + } + }, + "responses": { + "201": { "description": "" }, + "403": { "description": "" }, + "500": { "description": "Failed to run sql query" } + }, + "security": [{ "bearer": [] }], + "summary": "[Beta] Run sql query", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/webhooks/enable": { + "post": { + "operationId": "v1-enable-database-webhook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "responses": { + "201": { "description": "" }, + "403": { "description": "" }, + "500": { "description": "Failed to enable Database Webhooks on the project" } + }, + "security": [{ "bearer": [] }], + "summary": "[Beta] Enables Database Webhooks on the project", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/context": { + "get": { + "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-database-metadata", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/GetProjectDbMetadataResponse" } + } + } + }, + "403": { "description": "" } + }, + "security": [{ "bearer": [] }], + "summary": "Gets database metadata for the given project.", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/jit": { + "get": { + "description": "Mappings of roles a user can assume in the project database", + "operationId": "v1-get-jit-access", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/JitAccessResponse" } } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to list database jit access" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Get user-id to role mappings for JIT access", + "tags": ["Database"] }, - "put": { - "operationId": "v1-upsert-a-migration", - "summary": "[Beta] Upsert a database migration without applying", - "description": "Only available to selected partner OAuth apps", + "post": { + "description": "Authorizes the request to assume a role in the project database", + "operationId": "v1-authorize-jit-access", "parameters": [ { "name": "ref", @@ -3116,36 +3483,35 @@ "in": "path", "description": "Project ref", "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } - }, - { - "name": "Idempotency-Key", - "required": false, - "in": "header", - "description": "A unique key to ensure the same migration is tracked only once.", - "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V1UpsertMigrationBody" } + "schema": { "$ref": "#/components/schemas/AuthorizeJitAccessBody" } } } }, "responses": { - "200": { "description": "" }, + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/JitAuthorizeAccessResponse" } + } + } + }, "403": { "description": "" }, - "500": { "description": "Failed to upsert database migration" } + "500": { "description": "Failed to authorize database jit access" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] - } - }, - "/v1/projects/{ref}/database/query": { - "post": { - "operationId": "v1-run-a-query", - "summary": "[Beta] Run sql query", + "security": [{ "bearer": [] }], + "summary": "Authorize user-id to role mappings for JIT access", + "tags": ["Database"] + }, + "put": { + "description": "Modifies the roles that can be assumed and for how long", + "operationId": "v1-update-jit-access", "parameters": [ { "name": "ref", @@ -3158,22 +3524,28 @@ "requestBody": { "required": true, "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/V1RunQueryBody" } } + "application/json": { "schema": { "$ref": "#/components/schemas/UpdateJitAccessBody" } } } }, "responses": { - "201": { "description": "" }, + "200": { + "description": "", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/JitAccessResponse" } } + } + }, "403": { "description": "" }, - "500": { "description": "Failed to run sql query" } + "500": { "description": "Failed to upsert database migration" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates a user mapping for JIT access", + "tags": ["Database"] } }, - "/v1/projects/{ref}/database/webhooks/enable": { - "post": { - "operationId": "v1-enable-database-webhook", - "summary": "[Beta] Enables Database Webhooks on the project", + "/v1/projects/{ref}/database/jit/list": { + "get": { + "description": "Mappings of roles a user can assume in the project database", + "operationId": "v1-list-jit-access", "parameters": [ { "name": "ref", @@ -3184,20 +3556,26 @@ } ], "responses": { - "201": { "description": "" }, + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/JitListAccessResponse" } + } + } + }, "403": { "description": "" }, - "500": { "description": "Failed to enable Database Webhooks on the project" } + "500": { "description": "Failed to list database jit access" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all user-id to role mappings for JIT access", + "tags": ["Database"] } }, - "/v1/projects/{ref}/database/context": { - "get": { - "operationId": "v1-get-database-metadata", - "summary": "Gets database metadata for the given project.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", - "deprecated": true, + "/v1/projects/{ref}/database/jit/{user_id}": { + "delete": { + "description": "Remove JIT mappings of a user, revoking all JIT database access", + "operationId": "v1-delete-jit-access", "parameters": [ { "name": "ref", @@ -3205,28 +3583,28 @@ "in": "path", "description": "Project ref", "schema": { "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "type": "string" } + }, + { + "name": "user_id", + "required": true, + "in": "path", + "schema": { "format": "uuid", "type": "string" } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/GetProjectDbMetadataResponse" } - } - } - }, - "403": { "description": "" } + "200": { "description": "" }, + "403": { "description": "" }, + "500": { "description": "Failed to remove JIT access" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Delete JIT access by user-id", + "tags": ["Database"] } }, "/v1/projects/{ref}/functions": { "get": { - "operationId": "v1-list-all-functions", - "summary": "List all functions", "description": "Returns all functions you've previously added to the specified project.", + "operationId": "v1-list-all-functions", "parameters": [ { "name": "ref", @@ -3251,25 +3629,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve project's functions" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List all functions", + "tags": ["Edge Functions"] }, "post": { - "operationId": "v1-create-a-function", - "summary": "Create a function", - "description": "This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.", "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/vnd.denoland.eszip": { - "schema": { "type": "string", "format": "binary" } - }, - "application/json": { - "schema": { "$ref": "#/components/schemas/V1CreateFunctionBody" } - } - } - }, + "description": "This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.", + "operationId": "v1-create-a-function", "parameters": [ { "name": "ref", @@ -3318,6 +3685,17 @@ "schema": { "type": "string" } } ], + "requestBody": { + "required": true, + "content": { + "application/vnd.denoland.eszip": { + "schema": { "type": "string", "format": "binary" } + }, + "application/json": { + "schema": { "$ref": "#/components/schemas/V1CreateFunctionBody" } + } + } + }, "responses": { "201": { "description": "", @@ -3325,16 +3703,17 @@ "application/json": { "schema": { "$ref": "#/components/schemas/FunctionResponse" } } } }, + "402": { "description": "Maximum number of functions reached for Plan" }, "403": { "description": "" }, "500": { "description": "Failed to create project's function" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Create a function", + "tags": ["Edge Functions"] }, "put": { - "operationId": "v1-bulk-update-functions", - "summary": "Bulk update functions", "description": "Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.", + "operationId": "v1-bulk-update-functions", "parameters": [ { "name": "ref", @@ -3361,18 +3740,19 @@ } } }, + "402": { "description": "Maximum number of functions reached for Plan" }, "403": { "description": "" }, "500": { "description": "Failed to update functions" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Bulk update functions", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/deploy": { "post": { - "operationId": "v1-deploy-a-function", - "summary": "Deploy a function", "description": "A new endpoint to deploy functions. It will create if function does not exist.", + "operationId": "v1-deploy-a-function", "parameters": [ { "name": "ref", @@ -3412,18 +3792,19 @@ } } }, + "402": { "description": "Maximum number of functions reached for Plan" }, "403": { "description": "" }, "500": { "description": "Failed to deploy function" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Deploy a function", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/{function_slug}": { "get": { - "operationId": "v1-get-a-function", - "summary": "Retrieve a function", "description": "Retrieves a function with the specified slug and project.", + "operationId": "v1-get-a-function", "parameters": [ { "name": "ref", @@ -3452,24 +3833,13 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve function with given slug" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Retrieve a function", + "tags": ["Edge Functions"] }, "patch": { - "operationId": "v1-update-a-function", - "summary": "Update a function", "description": "Updates a function with the specified slug and project.", - "requestBody": { - "required": true, - "content": { - "application/vnd.denoland.eszip": { - "schema": { "type": "string", "format": "binary" } - }, - "application/json": { - "schema": { "$ref": "#/components/schemas/V1UpdateFunctionBody" } - } - } - }, + "operationId": "v1-update-a-function", "parameters": [ { "name": "ref", @@ -3525,6 +3895,17 @@ "schema": { "type": "string" } } ], + "requestBody": { + "required": true, + "content": { + "application/vnd.denoland.eszip": { + "schema": { "type": "string", "format": "binary" } + }, + "application/json": { + "schema": { "$ref": "#/components/schemas/V1UpdateFunctionBody" } + } + } + }, "responses": { "200": { "description": "", @@ -3535,13 +3916,13 @@ "403": { "description": "" }, "500": { "description": "Failed to update function with given slug" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Update a function", + "tags": ["Edge Functions"] }, "delete": { - "operationId": "v1-delete-a-function", - "summary": "Delete a function", "description": "Deletes a function with the specified slug from the specified project.", + "operationId": "v1-delete-a-function", "parameters": [ { "name": "ref", @@ -3563,15 +3944,15 @@ "403": { "description": "" }, "500": { "description": "Failed to delete function with given slug" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Delete a function", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/{function_slug}/body": { "get": { - "operationId": "v1-get-a-function-body", - "summary": "Retrieve a function body", "description": "Retrieves a function body for the specified slug and project.", + "operationId": "v1-get-a-function-body", "parameters": [ { "name": "ref", @@ -3598,14 +3979,14 @@ "403": { "description": "" }, "500": { "description": "Failed to retrieve function body with given slug" } }, - "tags": ["Edge Functions"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Retrieve a function body", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/storage/buckets": { "get": { "operationId": "v1-list-all-buckets", - "summary": "Lists all buckets", "parameters": [ { "name": "ref", @@ -3630,14 +4011,14 @@ "403": { "description": "" }, "500": { "description": "Failed to get list of buckets" } }, - "tags": ["Storage"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists all buckets", + "tags": ["Storage"] } }, "/v1/projects/{ref}/config/auth/sso/providers": { "post": { "operationId": "v1-create-a-sso-provider", - "summary": "Creates a new SSO provider", "parameters": [ { "name": "ref", @@ -3665,12 +4046,12 @@ "403": { "description": "" }, "404": { "description": "SAML 2.0 support is not enabled for this project" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Creates a new SSO provider", + "tags": ["Auth"] }, "get": { "operationId": "v1-list-all-sso-provider", - "summary": "Lists all SSO providers", "parameters": [ { "name": "ref", @@ -3692,14 +4073,14 @@ "403": { "description": "" }, "404": { "description": "SAML 2.0 support is not enabled for this project" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists all SSO providers", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/sso/providers/{provider_id}": { "get": { "operationId": "v1-get-a-sso-provider", - "summary": "Gets a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -3729,12 +4110,12 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets a SSO provider by its UUID", + "tags": ["Auth"] }, "put": { "operationId": "v1-update-a-sso-provider", - "summary": "Updates a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -3770,12 +4151,12 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Updates a SSO provider by its UUID", + "tags": ["Auth"] }, "delete": { "operationId": "v1-delete-a-sso-provider", - "summary": "Removes a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -3805,14 +4186,14 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Removes a SSO provider by its UUID", + "tags": ["Auth"] } }, "/v1/projects/{ref}/database/backups": { "get": { "operationId": "v1-list-all-backups", - "summary": "Lists all backups", "parameters": [ { "name": "ref", @@ -3832,14 +4213,14 @@ "403": { "description": "" }, "500": { "description": "Failed to get backups" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Lists all backups", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/backups/restore-pitr": { "post": { "operationId": "v1-restore-pitr-backup", - "summary": "Restores a PITR backup for a database", "parameters": [ { "name": "ref", @@ -3856,15 +4237,14 @@ } }, "responses": { "201": { "description": "" }, "403": { "description": "" } }, - "tags": ["Database"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Restores a PITR backup for a database", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/backups/restore-point": { "post": { "operationId": "v1-create-restore-point", - "x-internal": true, - "summary": "Initiates a creation of a restore point for a database", "parameters": [ { "name": "ref", @@ -3890,15 +4270,16 @@ "schema": { "$ref": "#/components/schemas/V1RestorePointResponse" } } } - } + }, + "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Initiates a creation of a restore point for a database", "tags": ["Database"], - "security": [{ "bearer": [] }] + "x-internal": true }, "get": { "operationId": "v1-get-restore-point", - "x-internal": true, - "summary": "Get restore points for project", "parameters": [ { "name": "ref", @@ -3926,15 +4307,15 @@ "403": { "description": "" }, "500": { "description": "Failed to get requested restore points" } }, + "security": [{ "bearer": [] }], + "summary": "Get restore points for project", "tags": ["Database"], - "security": [{ "bearer": [] }] + "x-internal": true } }, "/v1/projects/{ref}/database/backups/undo": { "post": { "operationId": "v1-undo", - "x-internal": true, - "summary": "Initiates an undo to a given restore point", "parameters": [ { "name": "ref", @@ -3951,14 +4332,15 @@ } }, "responses": { "201": { "description": "" }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Initiates an undo to a given restore point", "tags": ["Database"], - "security": [{ "bearer": [] }] + "x-internal": true } }, "/v1/organizations/{slug}/members": { "get": { "operationId": "v1-list-organization-members", - "summary": "List members of an organization", "parameters": [ { "name": "slug", @@ -3982,14 +4364,14 @@ }, "403": { "description": "" } }, - "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "List members of an organization", + "tags": ["Organizations"] } }, "/v1/organizations/{slug}": { "get": { "operationId": "v1-get-an-organization", - "summary": "Gets information about the organization", "parameters": [ { "name": "slug", @@ -4010,15 +4392,14 @@ }, "403": { "description": "" } }, - "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "security": [{ "bearer": [] }], + "summary": "Gets information about the organization", + "tags": ["Organizations"] } }, "/v1/organizations/{slug}/project-claim/{token}": { "get": { "operationId": "v1-get-organization-project-claim", - "x-internal": true, - "summary": "Gets project details for the specified organization and claim token", "parameters": [ { "name": "slug", @@ -4040,13 +4421,13 @@ }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Gets project details for the specified organization and claim token", "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "x-internal": true }, "post": { "operationId": "v1-claim-project-for-organization", - "x-internal": true, - "summary": "Claims project for the specified organization", "parameters": [ { "name": "slug", @@ -4058,8 +4439,10 @@ { "name": "token", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "403": { "description": "" } }, + "security": [{ "bearer": [] }], + "summary": "Claims project for the specified organization", "tags": ["Organizations"], - "security": [{ "bearer": [] }] + "x-internal": true } } }, @@ -4186,7 +4569,8 @@ }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, - "review_requested_at": { "type": "string", "format": "date-time" } + "review_requested_at": { "type": "string", "format": "date-time" }, + "with_data": { "type": "boolean" } }, "required": [ "id", @@ -4197,7 +4581,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] }, "BranchDeleteResponse": { @@ -4718,7 +5103,7 @@ }, "UpdateCustomHostnameBody": { "type": "object", - "properties": { "custom_hostname": { "type": "string" } }, + "properties": { "custom_hostname": { "type": "string", "minLength": 1 } }, "required": ["custom_hostname"] }, "NetworkBanResponse": { @@ -4749,42 +5134,116 @@ "RemoveNetworkBanRequest": { "type": "object", "properties": { - "ipv4_addresses": { "type": "array", "items": { "type": "string" } }, + "ipv4_addresses": { + "type": "array", + "items": { "type": "string" }, + "description": "List of IP addresses to unban." + }, + "requester_ip": { + "default": false, + "type": "boolean", + "description": "Include requester's public IP in the list of addresses to unban." + }, "identifier": { "type": "string" } }, "required": ["ipv4_addresses"] }, - "NetworkRestrictionsResponse": { + "NetworkRestrictionsResponse": { + "type": "object", + "properties": { + "entitlement": { "type": "string", "enum": ["disallowed", "allowed"] }, + "config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, + "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + }, + "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." + }, + "old_config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, + "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + }, + "description": "Populated when a new config has been received, but not registered as successfully applied to a project." + }, + "status": { "type": "string", "enum": ["stored", "applied"] }, + "updated_at": { "type": "string", "format": "date-time" }, + "applied_at": { "type": "string", "format": "date-time" } + }, + "required": ["entitlement", "config", "status"] + }, + "NetworkRestrictionsRequest": { + "type": "object", + "properties": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, + "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + } + }, + "NetworkRestrictionsPatchRequest": { + "type": "object", + "properties": { + "add": { + "type": "object", + "properties": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, + "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + } + }, + "remove": { + "type": "object", + "properties": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, + "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + } + } + } + }, + "NetworkRestrictionsV2Response": { "type": "object", "properties": { "entitlement": { "type": "string", "enum": ["disallowed", "allowed"] }, "config": { "type": "object", "properties": { - "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, - "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { "type": "string" }, + "type": { "type": "string", "enum": ["v4", "v6"] } + }, + "required": ["address", "type"] + } + } }, "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." }, "old_config": { "type": "object", "properties": { - "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, - "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { "type": "string" }, + "type": { "type": "string", "enum": ["v4", "v6"] } + }, + "required": ["address", "type"] + } + } }, "description": "Populated when a new config has been received, but not registered as successfully applied to a project." }, + "updated_at": { "type": "string", "format": "date-time" }, + "applied_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": ["stored", "applied"] } }, "required": ["entitlement", "config", "status"] }, - "NetworkRestrictionsRequest": { - "type": "object", - "properties": { - "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, - "dbAllowedCidrsV6": { "type": "array", "items": { "type": "string" } } - } - }, "PgsodiumConfigResponse": { "type": "object", "properties": { "root_key": { "type": "string" } }, @@ -4900,7 +5359,7 @@ "type": "object", "properties": { "status": { "type": "string", "enum": ["not-used", "custom-domain-used", "active"] }, - "custom_domain": { "type": "string" } + "custom_domain": { "type": "string", "minLength": 1 } }, "required": ["status"] }, @@ -5082,7 +5541,16 @@ "properties": { "name": { "type": "string", - "enum": ["auth", "db", "pooler", "realtime", "rest", "storage"] + "enum": [ + "auth", + "db", + "db_postgres_user", + "pooler", + "realtime", + "rest", + "storage", + "pg_bouncer" + ] }, "healthy": { "type": "boolean" }, "status": { "type": "string", "enum": ["COMING_UP", "ACTIVE_HEALTHY", "UNHEALTHY"] }, @@ -5251,9 +5719,22 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "capabilities": { + "type": "object", + "properties": { + "list_v2": { "type": "boolean" }, + "iceberg_catalog": { "type": "boolean" } + }, + "required": ["list_v2", "iceberg_catalog"] + }, + "external": { + "type": "object", + "properties": { "upstreamTarget": { "type": "string", "enum": ["main", "canary"] } }, + "required": ["upstreamTarget"] } }, - "required": ["fileSizeLimit", "features"] + "required": ["fileSizeLimit", "features", "capabilities", "external"] }, "UpdateStorageConfigBody": { "type": "object", @@ -5284,8 +5765,14 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "external": { + "type": "object", + "properties": { "upstreamTarget": { "type": "string", "enum": ["main", "canary"] } }, + "required": ["upstreamTarget"] } - } + }, + "additionalProperties": false }, "PostgresConfigResponse": { "type": "object", @@ -5342,7 +5829,8 @@ "wal_sender_timeout": { "type": "string" }, "work_mem": { "type": "string" }, "restart_database": { "type": "boolean" } - } + }, + "additionalProperties": false }, "V1PgbouncerConfigResponse": { "type": "object", @@ -5487,6 +5975,7 @@ "external_workos_secret": { "type": "string", "nullable": true }, "external_workos_url": { "type": "string", "nullable": true }, "external_web3_solana_enabled": { "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { "type": "boolean", "nullable": true }, "external_zoom_client_id": { "type": "string", "nullable": true }, "external_zoom_enabled": { "type": "boolean", "nullable": true }, "external_zoom_secret": { "type": "string", "nullable": true }, @@ -5536,6 +6025,8 @@ "mfa_phone_otp_length": { "type": "integer" }, "mfa_phone_template": { "type": "string", "nullable": true }, "mfa_phone_max_frequency": { "type": "integer", "nullable": true }, + "nimbus_oauth_client_id": { "type": "string", "nullable": true }, + "nimbus_oauth_client_secret": { "type": "string", "nullable": true }, "password_hibp_enabled": { "type": "boolean", "nullable": true }, "password_min_length": { "type": "integer", "nullable": true }, "password_required_characters": { @@ -5684,6 +6175,7 @@ "external_workos_secret", "external_workos_url", "external_web3_solana_enabled", + "external_web3_ethereum_enabled", "external_zoom_client_id", "external_zoom_enabled", "external_zoom_secret", @@ -5733,6 +6225,8 @@ "mfa_phone_otp_length", "mfa_phone_template", "mfa_phone_max_frequency", + "nimbus_oauth_client_id", + "nimbus_oauth_client_secret", "password_hibp_enabled", "password_min_length", "password_required_characters", @@ -6046,6 +6540,7 @@ "external_workos_secret": { "type": "string", "nullable": true }, "external_workos_url": { "type": "string", "nullable": true }, "external_web3_solana_enabled": { "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { "type": "boolean", "nullable": true }, "external_zoom_enabled": { "type": "boolean", "nullable": true }, "external_zoom_client_id": { "type": "string", "nullable": true }, "external_zoom_secret": { "type": "string", "nullable": true }, @@ -6069,7 +6564,9 @@ "maximum": 32767, "nullable": true }, - "mfa_phone_template": { "type": "string", "nullable": true } + "mfa_phone_template": { "type": "string", "nullable": true }, + "nimbus_oauth_client_id": { "type": "string", "nullable": true }, + "nimbus_oauth_client_secret": { "type": "string", "nullable": true } } }, "CreateThirdPartyAuthBody": { @@ -6380,7 +6877,8 @@ "auth_insufficient_mfa_options", "auth_password_policy_missing", "leaked_service_key", - "no_backup_admin" + "no_backup_admin", + "vulnerable_postgres_version" ] }, "title": { "type": "string" }, @@ -6459,6 +6957,119 @@ } } }, + "V1GetUsageApiCountResponse": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { "type": "string", "format": "date-time" }, + "total_auth_requests": { "type": "number" }, + "total_realtime_requests": { "type": "number" }, + "total_rest_requests": { "type": "number" }, + "total_storage_requests": { "type": "number" } + }, + "required": [ + "timestamp", + "total_auth_requests", + "total_realtime_requests", + "total_rest_requests", + "total_storage_requests" + ] + } + }, + "error": { + "oneOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "code": { "type": "number" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "domain": { "type": "string" }, + "location": { "type": "string" }, + "locationType": { "type": "string" }, + "message": { "type": "string" }, + "reason": { "type": "string" } + }, + "required": ["domain", "location", "locationType", "message", "reason"] + } + }, + "message": { "type": "string" }, + "status": { "type": "string" } + }, + "required": ["code", "errors", "message", "status"] + } + ] + } + } + }, + "V1GetUsageApiRequestsCountResponse": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { "count": { "type": "number" } }, + "required": ["count"] + } + }, + "error": { + "oneOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "code": { "type": "number" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "domain": { "type": "string" }, + "location": { "type": "string" }, + "locationType": { "type": "string" }, + "message": { "type": "string" }, + "reason": { "type": "string" } + }, + "required": ["domain", "location", "locationType", "message", "reason"] + } + }, + "message": { "type": "string" }, + "status": { "type": "string" } + }, + "required": ["code", "errors", "message", "status"] + } + ] + } + } + }, + "CreateRoleBody": { + "type": "object", + "properties": { "read_only": { "type": "boolean" } }, + "required": ["read_only"] + }, + "CreateRoleResponse": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "password": { "type": "string", "minLength": 1 }, + "ttl_seconds": { "type": "integer", "minimum": 1, "format": "int64" } + }, + "required": ["role", "password", "ttl_seconds"] + }, + "DeleteRolesResponse": { + "type": "object", + "properties": { "message": { "type": "string", "enum": ["ok"] } }, + "required": ["message"] + }, "V1ListMigrationsResponse": { "type": "array", "items": { @@ -6520,6 +7131,176 @@ }, "required": ["databases"] }, + "JitAccessResponse": { + "type": "object", + "properties": { + "user_id": { "type": "string", "format": "uuid" }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "expires_at": { "type": "number" }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + }, + "AuthorizeJitAccessBody": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "rhost": { "type": "string", "minLength": 1 } + }, + "required": ["role", "rhost"] + }, + "JitAuthorizeAccessResponse": { + "type": "object", + "properties": { + "user_id": { "type": "string", "format": "uuid" }, + "user_role": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "expires_at": { "type": "number" }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + }, + "required": ["user_id", "user_role"] + }, + "JitListAccessResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_id": { "type": "string", "format": "uuid" }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "expires_at": { "type": "number" }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + } + } + }, + "required": ["items"] + }, + "UpdateJitAccessBody": { + "type": "object", + "properties": { + "user_id": { "type": "string", "format": "uuid", "minLength": 1 }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { "type": "string", "minLength": 1 }, + "expires_at": { "type": "number" }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { "cidr": { "type": "string" } }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "roles"] + }, "FunctionResponse": { "type": "object", "properties": { @@ -6705,6 +7486,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["type"] @@ -6744,6 +7534,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -6806,6 +7605,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -6867,6 +7675,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -6919,6 +7736,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } } }, @@ -6957,6 +7783,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -7014,6 +7849,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] diff --git a/apps/docs/spec/cli_v1_commands.yaml b/apps/docs/spec/cli_v1_commands.yaml index 3951a586f39c6..52bb0f6876170 100644 --- a/apps/docs/spec/cli_v1_commands.yaml +++ b/apps/docs/spec/cli_v1_commands.yaml @@ -78,7 +78,7 @@ flags: name: --workdir description: path to a Supabase project directory default_value: '' - - id: "yes" + - id: 'yes' name: --yes description: answer yes to all prompts default_value: 'false' diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json index 0e81bfb4e9400..45d8e0d38156c 100644 --- a/apps/docs/spec/common-api-sections.json +++ b/apps/docs/spec/common-api-sections.json @@ -28,6 +28,12 @@ "type": "category", "title": "Analytics", "items": [ + { + "id": "v1-get-project-function-combined-stats", + "title": "Get project function combined stats", + "slug": "v1-get-project-function-combined-stats", + "type": "operation" + }, { "id": "v1-get-project-logs", "title": "Get project logs", @@ -196,6 +202,30 @@ "slug": "v1-apply-a-migration", "type": "operation" }, + { + "id": "v1-authorize-jit-access", + "title": "Authorize jit access", + "slug": "v1-authorize-jit-access", + "type": "operation" + }, + { + "id": "v1-create-login-role", + "title": "Create login role", + "slug": "v1-create-login-role", + "type": "operation" + }, + { + "id": "v1-delete-jit-access", + "title": "Delete jit access", + "slug": "v1-delete-jit-access", + "type": "operation" + }, + { + "id": "v1-delete-login-roles", + "title": "Delete login roles", + "slug": "v1-delete-login-roles", + "type": "operation" + }, { "id": "v1-disable-readonly-mode-temporarily", "title": "Disable readonly mode temporarily", @@ -226,6 +256,12 @@ "slug": "v1-get-database-metadata", "type": "operation" }, + { + "id": "v1-get-jit-access", + "title": "Get jit access", + "slug": "v1-get-jit-access", + "type": "operation" + }, { "id": "v1-get-pooler-config", "title": "Get pooler config", @@ -268,6 +304,12 @@ "slug": "v1-list-all-snippets", "type": "operation" }, + { + "id": "v1-list-jit-access", + "title": "List jit access", + "slug": "v1-list-jit-access", + "type": "operation" + }, { "id": "v1-list-migration-history", "title": "List migration history", @@ -298,6 +340,12 @@ "slug": "v1-setup-a-read-replica", "type": "operation" }, + { + "id": "v1-update-jit-access", + "title": "Update jit access", + "slug": "v1-update-jit-access", + "type": "operation" + }, { "id": "v1-update-pooler-config", "title": "Update pooler config", @@ -640,6 +688,12 @@ "slug": "v1-list-available-restore-versions", "type": "operation" }, + { + "id": "v1-patch-network-restrictions", + "title": "Patch network restrictions", + "slug": "v1-patch-network-restrictions", + "type": "operation" + }, { "id": "v1-pause-a-project", "title": "Pause a project", diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined.json b/apps/docs/spec/enrichments/tsdoc_v2/combined.json index d199510d40f51..f26b9fc972d82 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/combined.json @@ -16,78 +16,86 @@ "flags": {}, "children": [ { - "id": 227, + "id": 270, "name": "QueryData", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 123 + "target": 139 }, { - "id": 228, + "id": 271, "name": "QueryError", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 61 + "character": 61, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 127 + "target": 143 }, { - "id": 226, + "id": 269, "name": "QueryResult", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 121 + "target": 137 }, { - "id": 225, + "id": 268, "name": "SupabaseClientOptions", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 70 + "target": 83 }, { - "id": 130, + "id": 146, "name": "SupabaseClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" + "summary": [ + { + "kind": "text", + "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." + } + ] }, "children": [ { - "id": 131, + "id": 147, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -95,23 +103,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 70, - "character": 2 + "line": 99, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L99" } ], "signatures": [ { - "id": 132, + "id": 148, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Create a new client for use in the browser." + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] }, "typeParameter": [ { - "id": 133, + "id": 149, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -122,14 +136,64 @@ } }, { - "id": 134, - "name": "SchemaName", + "id": 152, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 151, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [151] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] + } + } + ] }, "default": { "type": "conditional", @@ -138,13 +202,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -158,27 +234,166 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } }, { - "id": 135, + "id": 153, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } + } + } + }, + { + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "default": { @@ -187,18 +402,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -214,20 +441,326 @@ }, "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" + } + } + }, + { + "id": 165, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [156] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 149, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 157, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 158, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 160, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [160] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [158] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 162, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [162] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 164, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [164] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } } } ], "parameters": [ { - "id": 136, + "id": 166, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] }, "type": { "type": "intrinsic", @@ -235,13 +768,18 @@ } }, { - "id": 137, + "id": 167, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] }, "type": { "type": "intrinsic", @@ -249,7 +787,7 @@ } }, { - "id": 138, + "id": 168, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -258,17 +796,17 @@ }, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -276,13 +814,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -292,15 +831,15 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, - "name": "auth", + "id": 105, + "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": { @@ -309,44 +848,132 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, - "children": [ + "sources": [ { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 - } - ], "type": { - "type": "intrinsic", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 89, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 90, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" + } + ], + "type": { + "type": "intrinsic", "name": "boolean" } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -354,13 +981,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -371,13 +1004,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -385,13 +1018,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -400,7 +1039,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -408,13 +1047,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -425,13 +1070,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -439,19 +1084,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -462,13 +1108,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -476,13 +1122,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -491,7 +1143,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -499,13 +1151,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -516,13 +1174,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -530,40 +1188,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -571,26 +1273,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -600,13 +1316,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -615,22 +1332,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -640,21 +1357,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -662,21 +1380,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -684,25 +1416,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -710,13 +1443,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -731,31 +1470,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -763,90 +1502,64 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -857,22 +1570,32 @@ ], "type": { "type": "reference", - "id": 130, + "id": 146, "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 134, + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + { + "type": "reference", + "id": 153, "name": "SchemaName" }, { "type": "reference", - "id": 135, + "id": 154, "name": "Schema" + }, + { + "type": "reference", + "id": 165, + "name": "ClientOptions" } ], "name": "default" @@ -881,7 +1604,7 @@ ] }, { - "id": 153, + "id": 184, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -892,21 +1615,30 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 54, - "character": 12 + "line": 82, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" } ], "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 82, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" + } + ], "signatures": [ { - "id": 155, + "id": 186, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -928,9 +1660,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -938,19 +1670,25 @@ } }, { - "id": 139, + "id": 169, "name": "auth", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + "summary": [ + { + "kind": "text", + "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 43, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L67" } ], "type": { @@ -959,7 +1697,7 @@ } }, { - "id": 142, + "id": 173, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -969,19 +1707,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 47, - "character": 12 + "line": 75, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L75" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 152, + "id": 183, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -992,8 +1731,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 53, - "character": 12 + "line": 81, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L81" } ], "type": { @@ -1002,7 +1742,7 @@ } }, { - "id": 147, + "id": 178, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1013,28 +1753,36 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 52, - "character": 12 + "line": 80, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 148, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 149, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 150, + "id": 181, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1044,21 +1792,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 151, + "id": 182, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1067,9 +1815,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -1078,14 +1826,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -1093,7 +1841,7 @@ } }, { - "id": 144, + "id": 175, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -1103,19 +1851,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 49, - "character": 12 + "line": 77, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L77" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 156, + "id": 187, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1125,8 +1874,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 12 + "line": 84, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L84" } ], "type": { @@ -1141,13 +1891,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 140, + "id": 170, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -1155,19 +1905,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 44, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L68" } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } }, { - "id": 141, + "id": 172, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -1177,19 +1928,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 46, - "character": 12 + "line": 74, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L74" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 145, + "id": 176, "name": "rest", "kind": 1024, "kindString": "Property", @@ -1199,8 +1951,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 50, - "character": 12 + "line": 78, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L78" } ], "type": { @@ -1208,27 +1961,105 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 134, - "name": "SchemaName" + "id": 165, + "name": "ClientOptions" }, { "type": "reference", - "id": 135, - "name": "Schema" + "id": 153, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } }, { - "id": 146, + "id": 171, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + } + ] + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L72" + } + ], + "type": { + "type": "reference", + "name": "StorageClient", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js" + } + }, + { + "id": 177, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -1238,8 +2069,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 51, - "character": 12 + "line": 79, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L79" } ], "type": { @@ -1248,7 +2080,7 @@ } }, { - "id": 143, + "id": 174, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -1258,109 +2090,114 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 48, - "character": 12 + "line": 76, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L76" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 158, + "id": 189, "name": "supabaseKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 101, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L101" + } + ], "type": { "type": "intrinsic", "name": "string" } }, { - "id": 157, + "id": 188, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 159, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] + }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 141, - "character": 6 + "line": 100, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L100" } ], - "getSignature": [ - { - "id": 160, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 161, - "name": "storage", + "id": 190, + "name": "functions", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 151, - "character": 6 + "line": 174, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L174" } ], - "getSignature": [ - { - "id": 162, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } + "getSignature": { + "id": 191, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Functions allows you to deploy and invoke edge functions." + } + ] + }, + "type": { + "type": "reference", + "name": "FunctionsClient", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js" } - ] + } }, { - "id": 200, + "id": 229, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -1370,13 +2207,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 271, - "character": 16 + "line": 300, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L300" } ], "signatures": [ { - "id": 201, + "id": 230, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -1398,15 +2236,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 217, + "id": 246, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -1416,33 +2254,34 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 331, - "character": 10 + "line": 364, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L364" } ], "signatures": [ { - "id": 218, + "id": 247, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 248, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "AuthChangeEvent", "qualifiedName": "AuthChangeEvent", - "package": "@supabase/auth-js", - "name": "AuthChangeEvent" + "package": "@supabase/auth-js" } }, { - "id": 220, + "id": 249, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -1462,7 +2301,7 @@ } }, { - "id": 221, + "id": 250, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -1483,7 +2322,7 @@ ] }, { - "id": 211, + "id": 240, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -1493,43 +2332,44 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 317, - "character": 10 + "line": 350, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L350" } ], "signatures": [ { - "id": 212, + "id": 241, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 242, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 202, + "id": 231, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -1539,30 +2379,31 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 281, - "character": 10 + "line": 310, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L310" } ], "signatures": [ { - "id": 203, + "id": 232, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 204, + "id": 233, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "dereferenced": { - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", @@ -1570,8 +2411,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 7, - "character": 17 + "line": 8, + "character": 17, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L8" } ], "extendedTypes": [ @@ -1584,7 +2426,7 @@ } }, { - "id": 205, + "id": 234, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -1603,13 +2445,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 206, + "id": 235, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -1619,21 +2461,28 @@ "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 208, + "id": 237, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 209, + "id": 238, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1643,21 +2492,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 210, + "id": 239, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1666,9 +2515,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -1677,14 +2526,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -1700,7 +2549,7 @@ ] }, { - "id": 214, + "id": 243, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1710,13 +2559,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 324, - "character": 10 + "line": 357, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L357" } ], "signatures": [ { - "id": 215, + "id": 244, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1724,18 +2574,25 @@ "type": { "type": "reflection", "declaration": { - "id": 216, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/auth-js/dist/module/GoTrueClient.d.ts", + "line": 313, + "character": 108 + } + ] } } } ] }, { - "id": 189, + "id": 218, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1743,29 +2600,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 243, - "character": 2 + "line": 272, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L272" } ], "signatures": [ { - "id": 190, + "id": 219, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + "summary": [ + { + "kind": "text", + "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + } + ] }, "parameters": [ { - "id": 191, + "id": 220, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel." + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "intrinsic", @@ -1773,34 +2641,39 @@ } }, { - "id": 192, + "id": 221, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The options to pass to the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "RealtimeChannelOptions", "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 163, + "id": 192, "name": "from", "kind": 2048, "kindString": "Method", @@ -1808,23 +2681,41 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 156, - "character": 2 + "line": 182, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L182" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 186, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L186" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 194, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L194" } ], "signatures": [ { - "id": 164, + "id": 193, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 165, + "id": 194, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1835,31 +2726,36 @@ } }, { - "id": 166, + "id": 195, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } } ], "parameters": [ { - "id": 167, + "id": 196, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 165, + "id": 194, "name": "TableName", "dereferenced": {} } @@ -1870,41 +2766,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, { "type": "reference", - "id": 165, + "id": 194, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 168, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -1912,23 +2820,28 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } }, { - "id": 169, + "id": 198, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 170, + "id": 199, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1939,31 +2852,36 @@ } }, { - "id": 171, + "id": 200, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 111, + "id": 127, "name": "GenericView" } } ], "parameters": [ { - "id": 172, + "id": 201, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName", "dereferenced": {} } @@ -1974,41 +2892,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 173, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -2016,15 +2946,15 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 193, + "id": 222, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -2032,34 +2962,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 250, - "character": 2 + "line": 279, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L279" } ], "signatures": [ { - "id": 194, + "id": 223, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all Realtime channels." + "summary": [ + { + "kind": "text", + "text": "Returns all Realtime channels." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } } ] }, { - "id": 198, + "id": 227, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -2067,19 +3003,25 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 267, - "character": 2 + "line": 296, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L296" } ], "signatures": [ { - "id": 199, + "id": 228, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all Realtime channels from Realtime client." + } + ] }, "type": { "type": "reference", @@ -2105,15 +3047,15 @@ } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 195, + "id": 224, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -2121,35 +3063,46 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 260, - "character": 2 + "line": 289, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L289" } ], "signatures": [ { - "id": 196, + "id": 225, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes Realtime channel from Realtime client." + } + ] }, "parameters": [ { - "id": 197, + "id": 226, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ], @@ -2174,15 +3127,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 178, + "id": 207, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2190,23 +3143,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 214, - "character": 2 + "line": 241, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L241" } ], "signatures": [ { - "id": 179, + "id": 208, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 180, + "id": 209, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2217,43 +3176,53 @@ } }, { - "id": 181, + "id": 210, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 112, + "id": 128, "name": "GenericFunction" } } ], "parameters": [ { - "id": 182, + "id": 211, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 180, + "id": 209, "name": "FnName", "dereferenced": {} } }, { - "id": 183, + "id": 212, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -2263,32 +3232,37 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 184, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 188, + "id": 217, "name": "count", "kind": 1024, "kindString": "Property", @@ -2296,13 +3270,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 220, - "character": 6 + "line": 247, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L247" } ], "type": { @@ -2324,7 +3336,7 @@ } }, { - "id": 187, + "id": 216, "name": "get", "kind": 1024, "kindString": "Property", @@ -2332,13 +3344,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 219, - "character": 6 + "line": 246, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L246" } ], "type": { @@ -2347,7 +3373,7 @@ } }, { - "id": 186, + "id": 215, "name": "head", "kind": 1024, "kindString": "Property", @@ -2355,13 +3381,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, - "character": 6 + "line": 245, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L245" } ], "type": { @@ -2373,8 +3421,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [188, 187, 186] + "children": [217, 216, 215] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 244, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L244" } ] } @@ -2387,7 +3442,12 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { @@ -2400,7 +3460,7 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, @@ -2443,9 +3503,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -2476,29 +3536,33 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, { "type": "reference", - "id": 180, + "id": 209, "name": "FnName" }, { "type": "literal", "value": null + }, + { + "type": "literal", + "value": "RPC" } ], + "name": "default", "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 174, + "id": 203, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2506,24 +3570,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 180, - "character": 2 + "line": 206, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L206" } ], "signatures": [ { - "id": 175, + "id": 204, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 176, + "id": 205, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2536,17 +3605,22 @@ ], "parameters": [ { - "id": 177, + "id": 206, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema", "dereferenced": {} } @@ -2557,12 +3631,17 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 176, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 205, "name": "DynamicSchema" }, { @@ -2571,18 +3650,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 133, + "id": 149, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -2602,9 +3681,9 @@ } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] @@ -2613,35 +3692,34 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [131] + "children": [147] }, { "title": "Properties", - "kind": 1024, - "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] + "children": [ + 184, 169, 173, 183, 178, 175, 187, 170, 172, 176, 171, 177, 174, 189, 188 + ] }, { "title": "Accessors", - "kind": 262144, - "children": [159, 161] + "children": [190] }, { "title": "Methods", - "kind": 2048, - "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] + "children": [229, 246, 240, 231, 243, 218, 192, 222, 227, 224, 207, 203] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 31, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L31" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 222, + "id": 251, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2652,25 +3730,87 @@ } }, { - "id": 223, - "name": "SchemaName", + "id": 254, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intersection", + "type": "union", "types": [ { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" + "type": "reflection", + "declaration": { + "id": 252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 253, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [253] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] } } ] @@ -2686,8 +3826,20 @@ "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { @@ -2706,8 +3858,20 @@ "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -2715,1651 +3879,761 @@ } }, { - "id": 224, - "name": "Schema", + "id": 255, + "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "id": 116, - "name": "GenericSchema" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] }, "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "trueType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + } + } + } + }, + { + "id": 256, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" } - } - } - ] - }, - { - "id": 2, - "name": "createClient", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 27, - "character": 13 - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Supabase Client." }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { "type": "reference", - "id": 116, - "name": "GenericSchema" + "id": 153, + "name": "SchemaName" }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { + "objectType": { + "type": "reference", + "typeArguments": [ + { "type": "reference", - "id": 4, + "id": 149, "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 116, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" }, - "objectType": { - "type": "intrinsic", - "name": "any" + { + "type": "literal", + "value": "__InternalSupabase" } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, - { - "id": 8, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" }, - { - "id": 9, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" }, - "type": { + "objectType": { "type": "reference", - "id": 70, "typeArguments": [ { "type": "reference", - "id": 5, - "name": "SchemaName" + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" } ], - "name": "SupabaseClientOptions", - "dereferenced": { - "id": 70, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + }, + { + "id": 267, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 257, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 258, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 92, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" } ], "type": { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [258] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 149, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 259, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 260, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 75, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 261, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 262, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 83, - "name": "debug", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 80, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 82, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 84, - "name": "lock", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 79, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 81, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 78, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] - } - ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 - } - ] - } - } - }, - { - "id": 72, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 74, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "SchemaName", - "dereferenced": {} - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [74] + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 - } - ] - } - } - }, - { - "id": 86, - "name": "global", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 69, - "name": "Fetch", - "dereferenced": { - "id": 69, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 28, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - } - } - }, - { - "id": 89, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 89] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 - } - ] - } - } - }, - { - "id": 85, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, - "sources": [ + "groups": [ { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "title": "Properties", + "children": [262] } ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - }, - { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ] } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] - } - ], + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [260] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 263, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 264, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" } - ] + ], + "type": { + "type": "literal", + "value": "12" + } } - } + ], + "groups": [ + { + "title": "Properties", + "children": [264] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] } } - } - ], - "type": { - "type": "reference", - "id": 130, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { + }, + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "References", - "kind": 16777216, - "children": [227, 228, 226, 225] - }, - { - "title": "Classes", - "kind": 128, - "children": [130] - }, - { - "title": "Functions", - "kind": 64, - "children": [2] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 10, - "name": "lib/constants", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 22, - "name": "DEFAULT_AUTH_OPTIONS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 28, - "character": 13 - } - ], - "type": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - }, - "defaultValue": "..." - }, - { - "id": 19, - "name": "DEFAULT_DB_OPTIONS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 24, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 20, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 21, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "id": 152, + "name": "SchemaNameOrClientOptions" }, - "defaultValue": "'public'" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [21] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 14, - "name": "DEFAULT_GLOBAL_OPTIONS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 20, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 15, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 16, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 21, - "character": 2 - } - ], - "type": { + "extendsType": { "type": "reflection", "declaration": { - "id": 17, + "id": 265, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 18, - "name": "X-Client-Info", + "id": 266, + "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/lib/constants.ts", - "line": 18, - "character": 33 + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ], "type": { "type": "intrinsic", "name": "string" - }, - "defaultValue": "..." + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [18] + "children": [266] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ] } }, - "defaultValue": "DEFAULT_HEADERS" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [16] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 11, - "name": "DEFAULT_HEADERS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 18, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 13, - "name": "X-Client-Info", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 18, - "character": 33 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "trueType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [13] + "falseType": { + "type": "intrinsic", + "name": "never" + } } - ] + } } - }, - "defaultValue": "..." + ] }, { - "id": 23, - "name": "DEFAULT_REALTIME_OPTIONS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 35, - "character": 13 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [22, 19, 14, 11, 23] - } - ], - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 24, - "name": "lib/fetch", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 38, - "name": "fetchWithAuth", + "id": 2, + "name": "createClient", "kind": 64, "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/fetch.ts", - "line": 26, - "character": 13 + "fileName": "src/index.ts", + "line": 27, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L27" } ], "signatures": [ { - "id": 39, - "name": "fetchWithAuth", + "id": 3, + "name": "createClient", "kind": 4096, "kindString": "Call signature", "flags": {}, - "parameters": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates a new Supabase Client." + } + ] + }, + "typeParameter": [ { - "id": 40, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "type": { + "default": { "type": "intrinsic", - "name": "string" + "name": "any" } }, { - "id": 41, - "name": "getAccessToken", - "kind": 32768, - "kindString": "Parameter", + "id": 7, + "name": "SchemaNameOrClientOptions", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 42, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 43, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 44, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 45, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 46, + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 5, "name": "__type", - "kind": 4096, - "kindString": "Call signature", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ + "children": [ { - "id": 47, - "name": "input", - "kind": 32768, - "kindString": "Parameter", + "id": 6, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ], "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] + "type": "intrinsic", + "name": "string" } - }, + } + ], + "groups": [ { - "id": 48, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } + "title": "Properties", + "children": [6] } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ] } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 50, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ { - "id": 51, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" } }, { - "id": 52, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } + "type": "literal", + "value": "__InternalSupabase" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - } - ] - }, - { - "id": 25, - "name": "resolveFetch", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 6, - "character": 13 - } - ], - "signatures": [ - { - "id": 26, - "name": "resolveFetch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 27, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ { - "id": 29, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ { - "id": 30, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" } }, { - "id": 31, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } + "type": "literal", + "value": "__InternalSupabase" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 32, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 33, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 34, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 35, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - } - ] - }, - { - "id": 36, - "name": "resolveHeadersConstructor", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 18, - "character": 13 - } - ], - "signatures": [ - { - "id": 37, - "name": "resolveHeadersConstructor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [38, 25, 36] - } - ], - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 53, - "name": "lib/helpers", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 59, - "name": "applySettingDefaults", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 60, - "name": "applySettingDefaults", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 61, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } }, { - "id": 62, + "id": 8, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4371,23 +4645,11 @@ "default": { "type": "conditional", "checkType": { - "type": "literal", - "value": "public" + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 61, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { "type": "intersection", "types": [ { @@ -4395,39 +4657,153 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 61, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } } } } ], "parameters": [ { - "id": 63, - "name": "options", + "id": 9, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 10, + "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 11, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 62, + "id": 8, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -4435,13 +4811,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4451,15 +4828,15 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, - "name": "auth", + "id": 105, + "name": "accessToken", "kind": 1024, "kindString": "Property", "flags": { @@ -4468,35 +4845,123 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, - "children": [ + "sources": [ { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 89, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 90, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -4505,7 +4970,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -4513,13 +4978,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -4530,13 +5001,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -4544,13 +5015,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -4559,7 +5036,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -4567,13 +5044,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -4584,13 +5067,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -4598,19 +5081,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -4621,13 +5105,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -4635,13 +5119,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -4650,7 +5140,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -4658,13 +5148,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -4675,13 +5171,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -4689,40 +5185,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -4730,26 +5270,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -4759,13 +5313,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -4774,22 +5329,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -4799,21 +5354,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4821,21 +5377,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -4843,25 +5413,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4869,13 +5440,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -4890,31 +5467,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -4922,3439 +5499,2930 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } } } } - }, - { - "id": 64, - "name": "defaults", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { + } + ], + "type": { + "type": "reference", + "id": 146, + "typeArguments": [ + { "type": "reference", - "id": 70, - "typeArguments": [ - { + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { "type": "intrinsic", "name": "any" } - ], - "name": "SupabaseClientOptions", - "dereferenced": { - "id": 70, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 - } - ], - "typeParameter": [ + "type": "intrinsic", + "name": "string" + }, { - "id": 92, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } - ], - "type": { + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 4, + "name": "Database" + }, + "extendsType": { "type": "reflection", "declaration": { - "id": 71, + "id": 12, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, - "name": "auth", + "id": 13, + "name": "__InternalSupabase", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 14, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 83, - "name": "debug", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 80, - "name": "detectSessionInUrl", + "id": 15, + "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ], "type": { "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 82, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } + "name": "string" } - }, + } + ], + "groups": [ { - "id": 84, - "name": "lock", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, + "title": "Properties", + "children": [15] + } + ], + "sources": [ { - "id": 79, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 81, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 78, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ] } } - }, + } + ], + "groups": [ { - "id": 72, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 74, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "SchemaName", - "dereferenced": {} - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [74] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 - } - ] - } - } - }, + "title": "Properties", + "children": [13] + } + ], + "sources": [ { - "id": 86, - "name": "global", + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 17, + "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", + "fileName": "src/SupabaseClient.ts", "line": 59, - "character": 2 + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" } ], "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 69, - "name": "Fetch", - "dereferenced": { - "id": 69, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 28, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - } - } - }, - { - "id": 89, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 89] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 - } - ] - } + "type": "literal", + "value": "12" } - }, + } + ], + "groups": [ { - "id": 85, - "name": "realtime", + "title": "Properties", + "children": [17] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 19, + "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ], "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "type": "intrinsic", + "name": "string" } - }, - { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [19] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ] } - } - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 70, - "typeArguments": [ - { + }, + "trueType": { "type": "reference", - "id": 62, - "name": "SchemaName" + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - ], - "name": "SupabaseClientOptions" + } } ], - "qualifiedName": "Required", - "package": "typescript", - "name": "Required" + "name": "default" } } ] - }, + } + ], + "groups": [ { - "id": 56, - "name": "ensureTrailingSlash", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 12, - "character": 16 - } - ], - "signatures": [ - { - "id": 57, - "name": "ensureTrailingSlash", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 58, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] + "title": "References", + "children": [270, 271, 269, 268] }, { - "id": 65, - "name": "isBrowser", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 16, - "character": 13 - } - ], - "signatures": [ - { - "id": 66, - "name": "isBrowser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] + "title": "Classes", + "children": [146] }, - { - "id": 54, - "name": "uuid", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 4, - "character": 16 - } - ], - "signatures": [ - { - "id": 55, - "name": "uuid", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ { "title": "Functions", - "kind": 64, - "children": [59, 56, 65, 54] + "children": [2] } ], "sources": [ { - "fileName": "src/lib/helpers.ts", - "line": 2, - "character": 0 + "fileName": "src/index.ts", + "line": 1, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L1" } ] }, { - "id": 67, - "name": "lib/types", + "id": 20, + "name": "lib/constants", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 68, - "name": "SupabaseAuthClientOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, + "id": 32, + "name": "DEFAULT_AUTH_OPTIONS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 7, - "character": 17 + "fileName": "src/lib/constants.ts", + "line": 28, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L28" } ], - "extendedTypes": [ - { - "type": "reference", - "name": "AuthClientOptions" - } - ] + "type": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + }, + "defaultValue": "..." }, { - "id": 69, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + "id": 29, + "name": "DEFAULT_DB_OPTIONS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 28, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - }, - { - "id": 112, - "name": "GenericFunction", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 + "fileName": "src/lib/constants.ts", + "line": 24, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ], "type": { "type": "reflection", "declaration": { - "id": 113, + "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, - "name": "Args", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 115, - "name": "Returns", + "id": 31, + "name": "schema", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 + "fileName": "src/lib/constants.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L25" } ], "type": { "type": "intrinsic", - "name": "unknown" - } + "name": "string" + }, + "defaultValue": "'public'" } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [114, 115] + "children": [31] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 30 + "fileName": "src/lib/constants.ts", + "line": 24, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ] } - } + }, + "defaultValue": "..." }, { - "id": 107, - "name": "GenericNonUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + "id": 24, + "name": "DEFAULT_GLOBAL_OPTIONS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 + "fileName": "src/lib/constants.ts", + "line": 20, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 110, - "name": "Relationships", + "id": 26, + "name": "headers", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 + "fileName": "src/lib/constants.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L21" } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 93, - "name": "GenericRelationship" - } - } - }, - { - "id": 109, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 + "type": "reflection", + "declaration": { + "id": 27, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 28, + "name": "X-Client-Info", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [28] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" + } + ] } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } + }, + "defaultValue": "DEFAULT_HEADERS" } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [110, 109] + "children": [26] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 38 + "fileName": "src/lib/constants.ts", + "line": 20, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ] } - } + }, + "defaultValue": "..." }, { - "id": 93, - "name": "GenericRelationship", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + "id": 21, + "name": "DEFAULT_HEADERS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 12 + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { "type": "reflection", "declaration": { - "id": 94, + "id": 22, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 96, - "name": "columns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 95, - "name": "foreignKeyName", + "id": 23, + "name": "X-Client-Info", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { "type": "intrinsic", "name": "string" - } - }, - { - "id": 97, - "name": "isOneToOne", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 99, - "name": "referencedColumns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 98, - "name": "referencedRelation", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } + "defaultValue": "..." } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [96, 95, 97, 99, 98] + "children": [23] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 34 + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ] } - } + }, + "defaultValue": "..." }, { - "id": 116, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + "id": 33, + "name": "DEFAULT_REALTIME_OPTIONS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 12 + "fileName": "src/lib/constants.ts", + "line": 35, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L35" } ], "type": { - "type": "reflection", - "declaration": { - "id": 117, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 120, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 112, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 118, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 100, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 119, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 111, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [120, 118, 119] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 28 - } - ] - } - } - }, + "type": "reference", + "name": "RealtimeClientOptions", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "{}" + } + ], + "groups": [ { - "id": 100, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", + "title": "Variables", + "children": [32, 29, 24, 21, 33] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 2, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L2" + } + ] + }, + { + "id": 34, + "name": "lib/fetch", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 48, + "name": "fetchWithAuth", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 + "fileName": "src/lib/fetch.ts", + "line": 26, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L26" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 101, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "signatures": [ + { + "id": 49, + "name": "fetchWithAuth", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "children": [ + "parameters": [ { - "id": 103, - "name": "Insert", - "kind": 1024, - "kindString": "Property", + "id": 50, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 - } - ], "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "type": "intrinsic", + "name": "string" } }, { - "id": 105, - "name": "Relationships", - "kind": 1024, - "kindString": "Property", + "id": 51, + "name": "getAccessToken", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 2 - } - ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 93, - "name": "GenericRelationship" - } - } - }, - { - "id": 102, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 + "type": "reflection", + "declaration": { + "id": 52, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 28, + "character": 18, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L28" + } + ], + "signatures": [ + { + "id": 53, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" } }, { - "id": 104, - "name": "Update", - "kind": 1024, - "kindString": "Property", + "id": 54, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 55, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 56, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 57, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 58, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 59, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 2 + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" + "signatures": [ + { + "id": 60, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 61, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 62, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [103, 105, 102, 104] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 27 + } + ] } - ] + } } - } + ] }, { - "id": 106, - "name": "GenericUpdatableView", - "kind": 4194304, - "kindString": "Type alias", + "id": 35, + "name": "resolveFetch", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 + "fileName": "src/lib/fetch.ts", + "line": 6, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L6" } ], - "type": { - "type": "reference", - "id": 100, - "name": "GenericTable" - } - }, - { - "id": 111, - "name": "GenericView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + "signatures": [ { - "fileName": "src/lib/types.ts", - "line": 105, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "id": 106, - "name": "GenericUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 + "id": 36, + "name": "resolveFetch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 37, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 38, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 39, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 40, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 41, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } } - ], - "type": { - "type": "reference", - "id": 100, - "name": "GenericTable" } - }, - { - "id": 107, - "name": "GenericNonUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 110, - "name": "Relationships", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 + ], + "type": { + "type": "reflection", + "declaration": { + "id": 42, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 43, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 44, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] } - ], - "type": { - "type": "array", - "elementType": { + }, + { + "id": 45, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { "type": "reference", - "id": 93, - "name": "GenericRelationship" + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" } } - }, - { - "id": 109, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ + ], + "type": { + "type": "reference", + "typeArguments": [ { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [110, 109] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 38 + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } - ] - } + } + ] } } - ] - } + } + ] }, { - "id": 123, - "name": "QueryData", - "kind": 4194304, - "kindString": "Type alias", + "id": 46, + "name": "resolveHeadersConstructor", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 12 + "fileName": "src/lib/fetch.ts", + "line": 18, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L18" } ], - "typeParameter": [ + "signatures": [ { - "id": 126, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 126, - "name": "T" - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 124, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 125, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 51 - } - ], - "type": { - "type": "inferred", - "name": "U" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [125] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 49 - } - ] - } - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "U" - }, - { - "type": "literal", - "value": null - } - ], - "qualifiedName": "Exclude", - "package": "typescript", - "name": "Exclude" - }, - "falseType": { - "type": "intrinsic", - "name": "never" + "id": 47, + "name": "resolveHeadersConstructor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } } - } - }, + ] + } + ], + "groups": [ { - "id": 127, - "name": "QueryError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 123, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PostgrestError", - "package": "@supabase/postgrest-js", - "name": "PostgrestError" - } - }, + "title": "Functions", + "children": [48, 35, 46] + } + ], + "sources": [ { - "id": 121, - "name": "QueryResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Helper types for query results." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 122, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 122, - "name": "T" - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "inferred", - "name": "U" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "trueType": { - "type": "reference", - "name": "U" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, + "fileName": "src/lib/fetch.ts", + "line": 2, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L2" + } + ] + }, + { + "id": 63, + "name": "lib/helpers", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ { - "id": 70, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "id": 69, + "name": "applySettingDefaults", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "fileName": "src/lib/helpers.ts", + "line": 18, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L18" } ], - "typeParameter": [ + "signatures": [ { - "id": 92, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 70, + "name": "applySettingDefaults", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "children": [ + "typeParameter": [ { - "id": 75, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 - } - ], + "id": 71, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 72, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 83, - "name": "debug", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 80, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 82, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 84, - "name": "lock", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 79, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 71, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ { - "id": 81, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } + "type": "intrinsic", + "name": "string" }, { - "id": 78, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 71, + "name": "Database" } } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 - } ] } } - }, + } + ], + "parameters": [ { - "id": 72, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], + "id": 73, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reference", + "id": 83, + "typeArguments": [ + { + "type": "reference", + "id": 72, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions", + "dereferenced": { + "id": 83, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "children": [ + "sources": [ { - "id": 74, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "SchemaName", - "dereferenced": {} - } + "fileName": "src/lib/types.ts", + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "groups": [ + "typeParameters": [ { - "title": "Properties", - "kind": 1024, - "children": [74] + "id": 108, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} } ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 - } - ] - } - } - }, - { - "id": 86, - "name": "global", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ + "type": { + "type": "reflection", + "declaration": { + "id": 84, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 69, - "name": "Fetch", - "dereferenced": { - "id": 69, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" } ], "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 28, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] } } - } - } - }, - { - "id": 89, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ + }, { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" + "id": 88, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, - { - "type": "intrinsic", - "name": "string" + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 89, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 90, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 97, + "name": "debug", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "debug" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 93, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 96, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 98, + "name": "lock", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "lock" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 92, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 94, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 91, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ] + } } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [88, 89] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 - } - ] - } - } - }, - { - "id": 85, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - }, - { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null + }, + { + "id": 85, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, - { - "type": "intrinsic", - "name": "string" + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 87, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" + } + ], + "type": { + "type": "reference", + "id": 108, + "name": "SchemaName", + "dereferenced": {} + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [87] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ] + } } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + }, + { + "id": 101, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 102, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" + } + ], + "type": { + "type": "reference", + "id": 82, + "name": "Fetch", + "dereferenced": { + "id": 82, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 38, + "name": "fetch", + "qualifiedName": "fetch", + "package": "typescript" + } + } + } + } + }, + { + "id": 104, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [103, 104] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" + } + ] + } + } + }, + { + "id": 99, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" + } + ], + "type": { + "type": "reference", + "name": "RealtimeClientOptions", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js" + } + }, + { + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" + } + ], + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [105, 88, 85, 101, 99, 100] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ] + } } } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Interfaces", - "kind": 256, - "children": [68] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 128, - "name": "lib/version", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 129, - "name": "version", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "0.0.0-automated" - }, - "defaultValue": "'0.0.0-automated'" - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [129] - } - ], - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [1, 10, 24, 53, 67, 128] - } - ] - }, - { - "id": 0, - "name": "@supabase/auth-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1280, - "name": "AuthApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1281, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 33, - "character": 2 - } - ], - "signatures": [ - { - "id": 1282, - "name": "new AuthApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1283, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1284, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" } }, { - "id": 1285, - "name": "code", + "id": 74, + "name": "defaults", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, + "type": "reference", + "id": 83, + "typeArguments": [ { "type": "intrinsic", - "name": "string" + "name": "any" } - ] - } - } - ], - "type": { - "type": "reference", - "id": 1280, - "name": "AuthApiError" - }, - "overwrites": { - "type": "reference", - "id": 1272, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1271, - "name": "AuthError.constructor" - } - }, - { - "id": 1287, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1288, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1276, - "name": "AuthError.code" - } - }, - { - "id": 1286, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 1278, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1281] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1287, 1286] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1270, - "name": "AuthError" - } - ] - }, - { - "id": 1270, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1271, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 1272, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1273, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1274, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1275, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1270, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 1276, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1277, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - } - }, - { - "id": 1278, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1271] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1276, 1278] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 1280, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 1290, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1337, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1338, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 2 - } - ], - "signatures": [ - { - "id": 1339, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1340, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1341, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { + ], + "name": "SupabaseClientOptions", + "dereferenced": { + "id": 83, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ], + "typeParameters": [ + { + "id": 108, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { "type": "reflection", "declaration": { - "id": 1342, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1344, - "name": "code", + "id": 105, + "name": "accessToken", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/lib/errors.ts", + "fileName": "src/lib/types.ts", "line": 90, - "character": 57 + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } } }, { - "id": 1343, - "name": "error", + "id": 88, + "name": "auth", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 42 + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1344, 1343] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 1337, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1361, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1362, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } - }, - { - "id": 1345, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1346, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1348, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1347, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1348, 1347] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1359, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" - } - }, - { - "id": 1360, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } - }, - { - "id": 1349, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 2 - } - ], - "signatures": [ - { - "id": 1350, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1351, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1355, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1356, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1358, - "name": "code", - "kind": 1024, - "kindString": "Property", + "type": "reflection", + "declaration": { + "id": 89, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 28 + "id": 90, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 97, + "name": "debug", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "debug" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 93, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 96, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 98, + "name": "lock", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "lock" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 92, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 94, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 91, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], - "type": { - "type": "intrinsic", - "name": "string" + "groups": [ + { + "title": "Properties", + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ] + } + } + }, + { + "id": 85, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." } - }, + ] + }, + "sources": [ { - "id": 1357, - "name": "error", - "kind": 1024, - "kindString": "Property", + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 + "id": 87, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" + } + ], + "type": { + "type": "reference", + "id": 108, + "name": "SchemaName", + "dereferenced": {} + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } + "groups": [ + { + "title": "Properties", + "children": [87] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ] } - ], - "groups": [ + } + }, + { + "id": 101, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [1358, 1357] + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 1353, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1352, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1354, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1355, 1353, 1352, 1354] + ], + "type": { + "type": "reflection", + "declaration": { + "id": 102, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" + } + ], + "type": { + "type": "reference", + "id": 82, + "name": "Fetch", + "dereferenced": { + "id": 82, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 38, + "name": "fetch", + "qualifiedName": "fetch", + "package": "typescript" + } + } + } + } + }, + { + "id": 104, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [103, 104] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" + } + ] + } + } + }, + { + "id": 99, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" + } + ], + "type": { + "type": "reference", + "name": "RealtimeClientOptions", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js" + } + }, + { + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" + } + ], + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [105, 88, 85, 101, 99, 100] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ] + } + } } - ] + } } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 83, + "typeArguments": [ + { + "type": "reference", + "id": 72, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + ], + "name": "Required", + "qualifiedName": "Required", + "package": "typescript" } } ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1338] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1361, 1345, 1359, 1360] }, { - "title": "Methods", - "kind": 2048, - "children": [1349] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1328, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1329, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + "id": 66, + "name": "ensureTrailingSlash", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 2 + "fileName": "src/lib/helpers.ts", + "line": 12, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L12" } ], "signatures": [ { - "id": 1330, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", + "id": 67, + "name": "ensureTrailingSlash", + "kind": 4096, + "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1331, - "name": "message", + "id": 68, + "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -8365,2828 +8433,1572 @@ } ], "type": { - "type": "reference", - "id": 1328, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" + "type": "intrinsic", + "name": "string" } } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } + ] }, { - "id": 1334, - "name": "code", - "kind": 1024, - "kindString": "Property", + "id": 78, + "name": "isBrowser", + "kind": 64, + "kindString": "Function", "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 + "fileName": "src/lib/helpers.ts", + "line": 16, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L16" } ], - "type": { - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 79, + "name": "isBrowser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1335, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" + "name": "boolean" } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } + } + ] }, { - "id": 1332, - "name": "name", - "kind": 1024, - "kindString": "Property", + "id": 64, + "name": "uuid", + "kind": 64, + "kindString": "Function", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 + "fileName": "src/lib/helpers.ts", + "line": 4, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L4" } ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" - } + "signatures": [ + { + "id": 65, + "name": "uuid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] }, { - "id": 1333, - "name": "status", - "kind": 1024, - "kindString": "Property", + "id": 75, + "name": "validateSupabaseUrl", + "kind": 64, + "kindString": "Function", "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 + "fileName": "src/lib/helpers.ts", + "line": 82, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L82" } ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } + "signatures": [ + { + "id": 76, + "name": "validateSupabaseUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validates a Supabase client URL" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "- The validated base URL." + } + ] + }, + { + "tag": "@throws", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 77, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Supabase client URL string." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + } + ] } ], "groups": [ { - "title": "Constructors", - "kind": 512, - "children": [1329] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1334, 1332, 1333] + "title": "Functions", + "children": [69, 66, 78, 64, 75] } ], "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 82, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" + "fileName": "src/lib/helpers.ts", + "line": 2, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L2" } ] }, { - "id": 1413, - "name": "AuthInvalidJwtError", - "kind": 128, - "kindString": "Class", + "id": 80, + "name": "lib/types", + "kind": 2, + "kindString": "Module", "flags": {}, "children": [ { - "id": 1414, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + "id": 81, + "name": "SupabaseAuthClientOptions", + "kind": 256, + "kindString": "Interface", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 162, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 8, + "character": 17, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L8" } ], - "signatures": [ + "extendedTypes": [ { - "id": 1415, - "name": "new AuthInvalidJwtError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1416, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 1413, - "name": "AuthInvalidJwtError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } + "type": "reference", + "name": "AuthClientOptions" } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } + ] }, { - "id": 1419, - "name": "code", - "kind": 1024, - "kindString": "Property", + "id": 82, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1420, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } - }, - { - "id": 1417, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 + "type": "query", + "queryType": { + "type": "reference", + "id": 38, + "name": "fetch", + "qualifiedName": "fetch", + "package": "typescript" } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" } }, { - "id": 1418, - "name": "status", - "kind": 1024, - "kindString": "Property", + "id": 128, + "name": "GenericFunction", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 117, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" } ], "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1414] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1419, 1417, 1418] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 161, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1320, - "name": "AuthInvalidTokenResponseError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1321, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 2 - } - ], - "signatures": [ - { - "id": 1322, - "name": "new AuthInvalidTokenResponseError", - "kind": 16384, - "kindString": "Constructor signature", + "type": "reflection", + "declaration": { + "id": 129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "type": { - "type": "reference", - "id": 1320, - "name": "AuthInvalidTokenResponseError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1325, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1326, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} + "children": [ + { + "id": 130, + "name": "Args", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L118" } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } - }, - { - "id": 1323, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 + }, + { + "id": 131, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 119, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L119" + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [130, 131] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 30, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" + } + ] } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" } }, { - "id": 1324, - "name": "status", - "kind": 1024, - "kindString": "Property", + "id": 123, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 110, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ], "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1321] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1325, 1323, 1324] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 76, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1364, - "name": "AuthPKCEGrantCodeExchangeError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1365, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 114, - "character": 2 - } - ], - "signatures": [ - { - "id": 1366, - "name": "new AuthPKCEGrantCodeExchangeError", - "kind": 16384, - "kindString": "Constructor signature", + "type": "reflection", + "declaration": { + "id": 124, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ + "children": [ { - "id": 1367, - "name": "message", - "kind": 32768, - "kindString": "Parameter", + "id": 126, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L112" + } + ], "type": { - "type": "intrinsic", - "name": "string" + "type": "array", + "elementType": { + "type": "reference", + "id": 109, + "name": "GenericRelationship" + } } }, { - "id": 1368, - "name": "details", - "kind": 32768, - "kindString": "Parameter", + "id": 125, + "name": "Row", + "kind": 1024, + "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L111" + } + ], "type": { - "type": "union", - "types": [ + "type": "reference", + "typeArguments": [ { - "type": "literal", - "value": null + "type": "intrinsic", + "name": "string" }, { - "type": "reflection", - "declaration": { - "id": 1369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1371, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 114, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1370, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 114, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1371, 1370] - } - ] - } + "type": "intrinsic", + "name": "unknown" } - ] - }, - "defaultValue": "null" + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } } ], - "type": { - "type": "reference", - "id": 1364, - "name": "AuthPKCEGrantCodeExchangeError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } + "groups": [ + { + "title": "Properties", + "children": [126, 125] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" + } + ] } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" } }, { - "id": 1388, - "name": "code", - "kind": 1024, - "kindString": "Property", + "id": 109, + "name": "GenericRelationship", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 93, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1389, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} + "type": "reflection", + "declaration": { + "id": 110, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 112, + "name": "columns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L95" } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 111, + "name": "foreignKeyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 94, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L94" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 113, + "name": "isOneToOne", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 96, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L96" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 115, + "name": "referencedColumns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 98, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L98" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 114, + "name": "referencedRelation", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L97" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [112, 111, 113, 115, 114] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" + } + ] + } } }, { - "id": 1372, - "name": "details", - "kind": 1024, - "kindString": "Property", + "id": 132, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 122, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1373, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 133, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 136, + "name": "Functions", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 1375, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 28 - } - ], - "type": { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L125" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { "type": "intrinsic", "name": "string" + }, + { + "type": "reference", + "id": 128, + "name": "GenericFunction" } - }, + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 134, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 1374, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 13 - } - ], - "type": { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L123" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { "type": "intrinsic", "name": "string" + }, + { + "type": "reference", + "id": 116, + "name": "GenericTable" } - } - ], - "groups": [ + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 135, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [1375, 1374] + "fileName": "src/lib/types.ts", + "line": 124, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L124" } - ] + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 127, + "name": "GenericView" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } } - } - ] - }, - "defaultValue": "null" + ], + "groups": [ + { + "title": "Properties", + "children": [136, 134, 135] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 122, + "character": 28, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" + } + ] + } + } }, { - "id": 1386, - "name": "name", - "kind": 1024, - "kindString": "Property", + "id": 116, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 101, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" } ], "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" + "type": "reflection", + "declaration": { + "id": 117, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 119, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L103" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 121, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L105" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 109, + "name": "GenericRelationship" + } + } + }, + { + "id": 118, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L102" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 120, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L104" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [119, 121, 118, 120] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 27, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" + } + ] + } } }, { - "id": 1387, - "name": "status", - "kind": 1024, - "kindString": "Property", + "id": 122, + "name": "GenericUpdatableView", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 108, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L108" } ], "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" + "id": 116, + "name": "GenericTable" } }, { - "id": 1376, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", + "id": 127, + "name": "GenericView", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 119, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L115" } ], - "signatures": [ - { - "id": 1377, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1382, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 124, - "character": 6 + "type": { + "type": "union", + "types": [ + { + "id": 122, + "name": "GenericUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L108" + } + ], + "type": { + "type": "reference", + "id": 116, + "name": "GenericTable" + } + }, + { + "id": 123, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 124, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 126, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L112" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 109, + "name": "GenericRelationship" + } } - ], - "type": { - "type": "union", - "types": [ + }, + { + "id": 125, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1383, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1385, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1384, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 112, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1385, 1384] - } - ] - } + "fileName": "src/lib/types.ts", + "line": 111, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L111" } - ] - }, - "defaultValue": "..." - }, - { - "id": 1380, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 122, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1379, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 121, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1381, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 123, - "character": 6 + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1382, 1380, 1379, 1381] - } - ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [126, 125] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" + } + ] + } } } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1365] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1388, 1372, 1386, 1387] + ] + } }, { - "title": "Methods", - "kind": 2048, - "children": [1376] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 111, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1391, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1392, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + "id": 139, + "name": "QueryData", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 130, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 132, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ], - "signatures": [ + "typeParameters": [ { - "id": 1393, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ + "id": 142, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 142, + "name": "T" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ { - "id": 1394, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 140, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 141, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 132, + "character": 51, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" + } + ], + "type": { + "type": "inferred", + "name": "U" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [141] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 132, + "character": 49, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" + } + ] } + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "U" }, { - "id": 1395, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } + "type": "literal", + "value": null } ], - "type": { - "type": "reference", - "id": 1391, - "name": "AuthRetryableFetchError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" } }, { - "id": 1398, - "name": "code", - "kind": 1024, - "kindString": "Property", + "id": 143, + "name": "QueryError", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 133, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L133" } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1399, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" + "name": "PostgrestError", + "qualifiedName": "PostgrestError", + "package": "@supabase/postgrest-js" } }, { - "id": 1396, - "name": "name", - "kind": 1024, - "kindString": "Property", + "id": 137, + "name": "QueryResult", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Helper types for query results." + } + ] + }, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 131, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L131" } ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" - } - }, - { - "id": 1397, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ + "typeParameters": [ { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 + "id": 138, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} } ], "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 138, + "name": "T" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "inferred", + "name": "U" + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + }, + "trueType": { + "type": "reference", + "name": "U" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1392] }, { - "title": "Properties", - "kind": 1024, - "children": [1398, 1396, 1397] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 129, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1312, - "name": "AuthSessionMissingError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1313, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + "id": 83, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, "sources": [ { - "fileName": "src/lib/errors.ts", - "line": 67, - "character": 2 - } - ], - "signatures": [ - { - "id": 1314, - "name": "new AuthSessionMissingError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "type": { - "type": "reference", - "id": 1312, - "name": "AuthSessionMissingError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } + "fileName": "src/lib/types.ts", + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1317, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ + "typeParameters": [ { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 + "id": 108, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1318, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } - }, - { - "id": 1315, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" - } - }, - { - "id": 1316, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1313] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1317, 1315, 1316] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1290, - "name": "AuthUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1291, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 1292, - "name": "new AuthUnknownError", - "kind": 16384, - "kindString": "Constructor signature", + "type": "reflection", + "declaration": { + "id": 84, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ - { - "id": 1293, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "children": [ { - "id": 1294, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 1290, - "name": "AuthUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 1272, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1271, - "name": "AuthError.constructor" - } - }, - { - "id": 1296, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, - { + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { "type": "reflection", "declaration": { - "id": 1297, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] } } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1276, - "name": "AuthError.code" - } - }, - { - "id": 1295, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1298, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1278, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1291] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1296, 1295, 1298] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 45, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1270, - "name": "AuthError" - } - ] - }, - { - "id": 1401, - "name": "AuthWeakPasswordError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." - }, - "children": [ - { - "id": 1402, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 150, - "character": 2 - } - ], - "signatures": [ - { - "id": 1403, - "name": "new AuthWeakPasswordError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1404, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1405, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } }, { - "id": 1406, - "name": "reasons", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "id": 1401, - "name": "AuthWeakPasswordError" - }, - "overwrites": { - "type": "reference", - "id": 1302, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1301, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1410, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" + "id": 88, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, - { + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ], + "type": { "type": "reflection", "declaration": { - "id": 1411, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1309, - "name": "CustomAuthError.code" - } - }, - { - "id": 1408, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 1307, - "name": "CustomAuthError.name" - } - }, - { - "id": 1407, - "name": "reasons", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Reasons why the password is deemed weak." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 148, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 606, - "name": "WeakPasswordReasons" - } - } - }, - { - "id": 1409, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 1308, - "name": "CustomAuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1402] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1410, 1408, 1407, 1409] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 144, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1300, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1301, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1302, - "name": "new CustomAuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 1303, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1304, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1305, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1306, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 1300, - "name": "CustomAuthError" - }, - "overwrites": { - "type": "reference", - "id": 1272, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 1271, - "name": "AuthError.constructor" - } - }, - { - "id": 1309, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - ] - }, - { - "type": "reference", - "name": "ErrorCode" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 1276, - "name": "AuthError.code" - } - }, - { - "id": 1307, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "name": "AuthError.name" - } - }, - { - "id": 1308, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "HTTP status code that caused the error." - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "id": 1278, - "name": "AuthError.status" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1301] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1309, 1307, 1308] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1270, - "name": "AuthError" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 1312, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "id": 1320, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "id": 1328, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "id": 1337, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "id": 1364, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "id": 1391, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "id": 1401, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "id": 1413, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 37, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new GoTrueAdminApi", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 11, - "name": "fetch", + "id": 90, + "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] + }, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 46, - "character": 4 + "fileName": "src/lib/types.ts", + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 13, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 14, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 15, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } + "type": "intrinsic", + "name": "boolean" } }, { - "id": 7, - "name": "headers", + "id": 97, + "name": "debug", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] + }, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 43, - "character": 4 + "fileName": "src/lib/types.ts", + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 9, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 10, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "debug" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" } } }, { - "id": 6, - "name": "url", + "id": 93, + "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] + }, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 42, - "character": 4 + "fileName": "src/lib/types.ts", + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [11, 7, 6] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 16, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Contains all MFA administration methods." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1152, - "name": "GoTrueAdminMFAApi", - "dereferenced": { - "id": 1152, - "name": "GoTrueAdminMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "children": [ - { - "id": 1156, - "name": "deleteFactor", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 1157, - "name": "deleteFactor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" - }, - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 1158, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 1136, - "name": "AuthMFAAdminDeleteFactorParams", - "dereferenced": { - "id": 1136, - "name": "AuthMFAAdminDeleteFactorParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1120, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1138, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1122, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1139, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user whose factor is being deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1138, 1139] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1120, - "character": 45 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1127, - "name": "AuthMFAAdminDeleteFactorResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 1153, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 1154, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all factors associated to a user." - }, - "parameters": [ - { - "id": 1155, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 1149, - "name": "AuthMFAAdminListFactorsParams", - "dereferenced": { - "id": 1149, - "name": "AuthMFAAdminListFactorsParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1144, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1151, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1146, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1151] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1144, - "character": 44 - } - ] - } - } - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1140, - "name": "AuthMFAAdminListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [1156, 1153] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1154, - "character": 17 - } - ] - } - } - }, - { - "id": 44, - "name": "createUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 160, - "character": 8 - } - ], - "signatures": [ - { - "id": 45, - "name": "createUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." - }, - "parameters": [ - { - "id": 46, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 787, - "name": "AdminUserAttributes", - "dereferenced": { - "id": 787, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 789, - "name": "app_metadata", + "id": 96, + "name": "flowType", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 421, - "character": 2 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { - "type": "intrinsic", - "name": "object" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } } }, { - "id": 792, - "name": "ban_duration", + "id": 98, + "name": "lock", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." + } + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 447, - "character": 2 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "lock" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } } }, { - "id": 799, - "name": "email", + "id": 92, + "name": "persistSession", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 372, - "character": 2 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.email" + "name": "boolean" } }, { - "id": 790, - "name": "email_confirm", + "id": 94, + "name": "storage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 428, - "character": 2 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { - "type": "intrinsic", - "name": "boolean" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } } }, { - "id": 795, - "name": "id", + "id": 91, + "name": "storageKey", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 472, - "character": 2 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { @@ -11195,1991 +10007,1441 @@ } }, { - "id": 797, - "name": "nonce", + "id": 95, + "name": "userStorage", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 389, - "character": 2 + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" } ], "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.nonce" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } } - }, + } + ], + "groups": [ { - "id": 796, - "name": "password", + "title": "Properties", + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" + } + ] + } + } + }, + { + "id": 85, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 87, + "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "The user's password." - }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 382, - "character": 2 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { "type": "reference", - "name": "Omit.password" + "id": 108, + "name": "SchemaName", + "dereferenced": {} } - }, + } + ], + "groups": [ { - "id": 794, - "name": "password_hash", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 465, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "title": "Properties", + "children": [87] + } + ], + "sources": [ { - "id": 798, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 377, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.phone" - } - }, + "fileName": "src/lib/types.ts", + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ] + } + } + }, + { + "id": 101, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 102, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "id": 791, - "name": "phone_confirm", + "id": 103, + "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 435, - "character": 2 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 793, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 456, - "character": 2 + "type": "reference", + "id": 82, + "name": "Fetch", + "dereferenced": { + "id": 82, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 38, + "name": "fetch", + "qualifiedName": "fetch", + "package": "typescript" + } + } } - ], - "type": { - "type": "intrinsic", - "name": "string" } }, { - "id": 788, - "name": "user_metadata", + "id": 104, + "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 411, - "character": 2 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { - "type": "intrinsic", - "name": "object" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [ - 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 - ] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 400, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 781, - "name": "UserAttributes" - }, - { - "type": "literal", - "value": "data" - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { + }, + { + "id": 99, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" + } + ], + "type": { "type": "reference", - "id": 704, - "name": "UserResponse" + "name": "RealtimeClientOptions", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + }, + { + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" + } + ], + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [105, 88, 85, 101, 99, 100] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ] } - ] + } + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [81] }, { - "id": 68, - "name": "deleteUser", - "kind": 2048, - "kindString": "Method", + "title": "Type Aliases", + "children": [82, 128, 123, 109, 132, 116, 122, 127, 139, 143, 137, 83] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L1" + } + ] + }, + { + "id": 144, + "name": "lib/version", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 145, + "name": "version", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" + } + ], + "type": { + "type": "literal", + "value": "0.0.0-automated" + }, + "defaultValue": "'0.0.0-automated'" + } + ], + "groups": [ + { + "title": "Variables", + "children": [145] + } + ], + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "children": [1, 20, 34, 63, 80, 144] + } + ] + }, + { + "id": 0, + "name": "@supabase/auth-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1285, + "name": "AuthApiError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1286, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 280, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 33, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L33" } ], "signatures": [ { - "id": 69, - "name": "deleteUser", - "kind": 4096, - "kindString": "Call signature", + "id": 1287, + "name": "new AuthApiError", + "kind": 16384, + "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Delete a user. Requires a `service_role` key." - }, "parameters": [ { - "id": 70, - "name": "id", + "id": 1288, + "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The user id you want to remove." - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 71, - "name": "shouldSoftDelete", + "id": 1289, + "name": "status", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, "type": { "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" + "name": "number" + } + }, + { + "id": 1290, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 704, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "id": 1285, + "name": "AuthApiError" + }, + "overwrites": { + "type": "reference", + "id": 1277, + "name": "AuthError.constructor" } } - ] + ], + "overwrites": { + "type": "reference", + "id": 1276, + "name": "AuthError.constructor" + } }, { - "id": 41, - "name": "generateLink", - "kind": 2048, - "kindString": "Method", + "id": 1292, + "name": "code", + "kind": 1024, + "kindString": "Property", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 126, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], - "signatures": [ - { - "id": 42, - "name": "generateLink", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" }, - "parameters": [ - { - "id": 43, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 1007, - "name": "GenerateLinkParams", - "dereferenced": { - "id": 1007, - "name": "GenerateLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 856, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "id": 982, - "name": "GenerateSignupLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 813, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 983, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 985, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 815, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 987, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 817, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1004, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 986, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 816, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 984, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 814, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 813, - "character": 39 - } - ] - } - } - }, - { - "id": 988, - "name": "GenerateInviteOrMagiclinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 820, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 989, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 991, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 823, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 992, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 824, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1004, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 990, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 821, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 820, - "character": 46 - } - ] - } - } - }, - { - "id": 993, - "name": "GenerateRecoveryLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 827, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 994, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 996, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 830, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 997, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 831, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1004, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 995, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 828, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 827, - "character": 41 - } - ] - } - } - }, - { - "id": 998, - "name": "GenerateEmailChangeLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 834, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 999, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1001, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 837, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1002, - "name": "newEmail", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 841, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1003, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 842, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1004, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 1000, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 835, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 834, - "character": 44 - } - ] - } - } - } - ] - } + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1293, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} } } - } - ], - "type": { + ] + }, + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 1008, - "name": "GenerateLinkResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "ErrorCode" } - } - ] + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1281, + "name": "AuthError.code" + } }, { - "id": 61, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", + "id": 1291, + "name": "status", + "kind": 1024, + "kindString": "Property", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 229, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 31, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L31" } ], - "signatures": [ - { - "id": 62, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 63, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 704, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "intrinsic", + "name": "number" + }, + "overwrites": { + "type": "reference", + "id": 1283, + "name": "AuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1286] }, { - "id": 34, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "children": [1292, 1291] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 30, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L30" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1275, + "name": "AuthError" + } + ] + }, + { + "id": 1275, + "name": "AuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1276, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 93, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 35, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", + "id": 1277, + "name": "new AuthError", + "kind": 16384, + "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, "parameters": [ { - "id": 36, - "name": "email", + "id": 1278, + "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 37, - "name": "options", + "id": 1279, + "name": "status", "kind": 32768, "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Additional options to be included when inviting.\n" + "flags": { + "isOptional": true }, "type": { - "type": "reflection", - "declaration": { - "id": 38, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 39, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 40, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [39, 40] - } - ] - } + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1280, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true }, - "defaultValue": "{}" + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { "type": "reference", - "typeArguments": [ + "id": 1275, + "name": "AuthError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 1281, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ { - "type": "reference", - "id": 704, - "name": "UserResponse" + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1282, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + } + }, + { + "id": 1283, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" } - ] + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1276] }, { - "id": 47, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "children": [1281, 1283] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L4" + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "Error", + "qualifiedName": "Error", + "package": "typescript" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 1285, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 1295, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1342, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1343, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 182, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "signatures": [ { - "id": 48, - "name": "listUsers", - "kind": 4096, - "kindString": "Call signature", + "id": 1344, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." - }, "parameters": [ { - "id": 49, - "name": "params", + "id": 1345, + "name": "message", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" - }, + "flags": {}, "type": { - "type": "reference", - "id": 1179, - "name": "PageParams", - "dereferenced": { - "id": 1179, - "name": "PageParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1213, - "character": 12 - } - ], - "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1346, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { "type": "reflection", "declaration": { - "id": 1180, + "id": 1347, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, - "name": "page", + "id": 1349, + "name": "code", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The page number" - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 1215, - "character": 2 + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { "type": "intrinsic", - "name": "number" + "name": "string" } }, { - "id": 1182, - "name": "perPage", + "id": 1348, + "name": "error", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Number of items returned per page" - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 1217, - "character": 2 + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { "type": "intrinsic", - "name": "number" + "name": "string" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1349, 1348] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 1213, - "character": 25 + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ] } } - } - } + ] + }, + "defaultValue": "null" } ], "type": { "type": "reference", - "typeArguments": [ + "id": 1342, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1366, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 50, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 51, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 185, - "character": 8 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 52, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 54, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 185, - "character": 31 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 53, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 185, - "character": 16 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 755, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [54, 53] - } - ] - } - }, - { - "type": "reference", - "id": 1172, - "name": "Pagination" - } - ] - } - }, - { - "id": 55, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 185, - "character": 59 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [51, 55] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 57, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 186, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 58, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 59, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 186, - "character": 16 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [59] - } - ] - } - } - }, - { - "id": 60, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 186, - "character": 29 - } - ], - "type": { - "type": "reference", - "id": 1270, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [57, 60] - } - ] - } - } - ] + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1367, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + ] + }, + { + "type": "reference", + "name": "ErrorCode" } - } - ] + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } }, { - "id": 27, - "name": "signOut", - "kind": 2048, - "kindString": "Method", + "id": 1350, + "name": "details", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 62, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], - "signatures": [ - { - "id": 28, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "parameters": [ - { - "id": 29, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "scope", - "kind": 32768, - "kindString": "Parameter", + { + "type": "reflection", + "declaration": { + "id": 1351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The logout sope.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 31, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "children": [ + { + "id": 1353, + "name": "code", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 32, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 65, - "character": 15 - } - ], - "type": { - "type": "literal", - "value": null - } - }, + "sources": [ { - "id": 33, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 65, - "character": 27 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 1270, - "name": "AuthError" - } - ] - } + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], - "groups": [ + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1352, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [32, 33] + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + ], + "groups": [ + { + "title": "Properties", + "children": [1353, 1352] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" + } + ] + } } + ] + }, + "defaultValue": "null" + }, + { + "id": 1364, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } }, { - "id": 64, - "name": "updateUserById", + "id": 1365, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + }, + { + "id": 1354, + "name": "toJSON", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 253, - "character": 8 + "fileName": "src/lib/errors.ts", + "line": 95, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L95" } ], "signatures": [ { - "id": 65, - "name": "updateUserById", + "id": 1355, + "name": "toJSON", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": { - "shortText": "Updates the user data." - }, - "parameters": [ - { - "id": 66, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 67, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", + "type": { + "type": "reflection", + "declaration": { + "id": 1356, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "reference", - "id": 787, - "name": "AdminUserAttributes", - "dereferenced": { - "id": 787, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", + "children": [ + { + "id": 1360, + "name": "details", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 789, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 421, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, + "sources": [ { - "id": 792, - "name": "ban_duration", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "fileName": "src/lib/errors.ts", + "line": 100, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L100" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 447, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 799, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 372, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.email" - } - }, - { - "id": 790, - "name": "email_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 428, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 795, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 472, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 797, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 389, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.nonce" - } - }, - { - "id": 796, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 382, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.password" - } - }, - { - "id": 794, - "name": "password_hash", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 465, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 798, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 377, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "Omit.phone" - } - }, - { - "id": 791, - "name": "phone_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 435, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 793, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 456, - "character": 2 + { + "type": "reflection", + "declaration": { + "id": 1361, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1363, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1362, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1363, 1362] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" + } + ] } - ], - "type": { - "type": "intrinsic", - "name": "string" } - }, + ] + }, + "defaultValue": "..." + }, + { + "id": 1358, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 788, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 411, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } + "fileName": "src/lib/errors.ts", + "line": 98, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L98" } ], - "groups": [ + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1357, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [ - 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 - ] + "fileName": "src/lib/errors.ts", + "line": 97, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L97" } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1359, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 400, - "character": 17 + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L99" } ], - "extendedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 781, - "name": "UserAttributes" - }, - { - "type": "literal", - "value": "data" - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - } - ] + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." } - } + ], + "groups": [ + { + "title": "Properties", + "children": [1360, 1358, 1357, 1359] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L96" + } + ] } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 704, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" } } ] @@ -13188,168 +11450,5997 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [2] + "children": [1343] }, { "title": "Properties", - "kind": 1024, - "children": [16] + "children": [1366, 1350, 1364, 1365] }, { "title": "Methods", - "kind": 2048, - "children": [44, 68, 41, 61, 34, 47, 27, 64] + "children": [1354] } ], "sources": [ { - "fileName": "src/GoTrueAdminApi.ts", - "line": 27, - "character": 21 + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L88" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" } ] }, { - "id": 78, - "name": "GoTrueClient", + "id": 1333, + "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 80, + "id": 1334, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/GoTrueClient.ts", - "line": 240, - "character": 2 + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L83" } ], "signatures": [ { - "id": 81, - "name": "new GoTrueClient", + "id": 1335, + "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, "parameters": [ { - "id": 82, - "name": "options", + "id": 1336, + "name": "message", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 584, - "name": "GoTrueClientOptions", - "dereferenced": { - "id": 584, - "name": "GoTrueClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 593, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 599, - "name": "debug", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 88, - "character": 21 - } - ], - "signatures": [ - { - "id": 601, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 602, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1333, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1339, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1340, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1337, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1338, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1334] + }, + { + "title": "Properties", + "children": [1339, 1337, 1338] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 82, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L82" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1418, + "name": "AuthInvalidJwtError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1419, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 162, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L162" + } + ], + "signatures": [ + { + "id": 1420, + "name": "new AuthInvalidJwtError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1421, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 1418, + "name": "AuthInvalidJwtError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1424, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1425, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1422, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1423, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1419] + }, + { + "title": "Properties", + "children": [1424, 1422, 1423] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 161, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L161" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1325, + "name": "AuthInvalidTokenResponseError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1326, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L77" + } + ], + "signatures": [ + { + "id": 1327, + "name": "new AuthInvalidTokenResponseError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 1325, + "name": "AuthInvalidTokenResponseError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1330, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1331, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1328, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1329, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1326] + }, + { + "title": "Properties", + "children": [1330, 1328, 1329] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 76, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L76" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1369, + "name": "AuthPKCEGrantCodeExchangeError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1370, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" + } + ], + "signatures": [ + { + "id": 1371, + "name": "new AuthPKCEGrantCodeExchangeError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1372, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1373, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1374, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1376, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1375, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1376, 1375] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 1369, + "name": "AuthPKCEGrantCodeExchangeError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1393, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1394, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1377, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1378, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1380, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1379, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1380, 1379] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 1391, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1392, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + }, + { + "id": 1381, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 119, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L119" + } + ], + "signatures": [ + { + "id": 1382, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1387, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 124, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L124" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 1388, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1390, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1389, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1390, 1389] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 1385, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 122, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L122" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1384, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 121, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L121" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1386, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 123, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L123" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [1387, 1385, 1384, 1386] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 120, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L120" + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1370] + }, + { + "title": "Properties", + "children": [1393, 1377, 1391, 1392] + }, + { + "title": "Methods", + "children": [1381] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 111, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L111" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1396, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1397, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 130, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L130" + } + ], + "signatures": [ + { + "id": 1398, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1399, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1400, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 1396, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1403, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1404, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1401, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1402, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1397] + }, + { + "title": "Properties", + "children": [1403, 1401, 1402] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 129, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L129" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1317, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1318, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L67" + } + ], + "signatures": [ + { + "id": 1319, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 1317, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1322, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1323, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1320, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1321, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1318] + }, + { + "title": "Properties", + "children": [1322, 1320, 1321] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 66, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L66" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1295, + "name": "AuthUnknownError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1296, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L48" + } + ], + "signatures": [ + { + "id": 1297, + "name": "new AuthUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1298, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1299, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 1295, + "name": "AuthUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 1277, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1276, + "name": "AuthError.constructor" + } + }, + { + "id": 1301, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1281, + "name": "AuthError.code" + } + }, + { + "id": 1300, + "name": "originalError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 46, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L46" + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1303, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1283, + "name": "AuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1296] + }, + { + "title": "Properties", + "children": [1301, 1300, 1303] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 45, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L45" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1275, + "name": "AuthError" + } + ] + }, + { + "id": 1406, + "name": "AuthWeakPasswordError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." + } + ] + }, + "children": [ + { + "id": 1407, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 150, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L150" + } + ], + "signatures": [ + { + "id": 1408, + "name": "new AuthWeakPasswordError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1409, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1410, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1411, + "name": "reasons", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "id": 1406, + "name": "AuthWeakPasswordError" + }, + "overwrites": { + "type": "reference", + "id": 1307, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1306, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 1415, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1416, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1314, + "name": "CustomAuthError.code" + } + }, + { + "id": 1413, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 1312, + "name": "CustomAuthError.name" + } + }, + { + "id": 1412, + "name": "reasons", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reasons why the password is deemed weak." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 148, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L148" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 606, + "name": "WeakPasswordReasons" + } + } + }, + { + "id": 1414, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 1313, + "name": "CustomAuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1407] + }, + { + "title": "Properties", + "children": [1415, 1413, 1412, 1414] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 144, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L144" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1305, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1306, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L59" + } + ], + "signatures": [ + { + "id": 1307, + "name": "new CustomAuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 1308, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1309, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1310, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1311, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 1305, + "name": "CustomAuthError" + }, + "overwrites": { + "type": "reference", + "id": 1277, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 1276, + "name": "AuthError.constructor" + } + }, + { + "id": 1314, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1315, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "reference", + "name": "ErrorCode" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1281, + "name": "AuthError.code" + } + }, + { + "id": 1312, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 56, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "name": "AuthError.name" + } + }, + { + "id": 1313, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "overwrites": { + "type": "reference", + "id": 1283, + "name": "AuthError.status" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [1306] + }, + { + "title": "Properties", + "children": [1314, 1312, 1313] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L55" + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1275, + "name": "AuthError" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 1317, + "name": "AuthSessionMissingError" + }, + { + "type": "reference", + "id": 1325, + "name": "AuthInvalidTokenResponseError" + }, + { + "type": "reference", + "id": 1333, + "name": "AuthInvalidCredentialsError" + }, + { + "type": "reference", + "id": 1342, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 1369, + "name": "AuthPKCEGrantCodeExchangeError" + }, + { + "type": "reference", + "id": 1396, + "name": "AuthRetryableFetchError" + }, + { + "type": "reference", + "id": 1406, + "name": "AuthWeakPasswordError" + }, + { + "type": "reference", + "id": 1418, + "name": "AuthInvalidJwtError" + } + ] + }, + { + "id": 1, + "name": "GoTrueAdminApi", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 37, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L37" + } + ], + "signatures": [ + { + "id": 3, + "name": "new GoTrueAdminApi", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 4, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 11, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 46, + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L46" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 13, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 15, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 7, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 8, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], + "indexSignature": { + "id": 9, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 10, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 6, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 42, + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L42" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [11, 7, 6] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 41, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L41" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + } + ] + }, + { + "id": 16, + "name": "mfa", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Contains all MFA administration methods." + } + ] + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L29" + } + ], + "type": { + "type": "reference", + "id": 1157, + "name": "GoTrueAdminMFAApi", + "dereferenced": { + "id": 1157, + "name": "GoTrueAdminMFAApi", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ + { + "tag": "@expermental", + "content": [] + } + ] + }, + "children": [ + { + "id": 1161, + "name": "deleteFactor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], + "signatures": [ + { + "id": 1162, + "name": "deleteFactor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] + }, + { + "tag": "@expermental", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 1163, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1141, + "name": "AuthMFAAdminDeleteFactorParams", + "dereferenced": { + "id": 1141, + "name": "AuthMFAAdminDeleteFactorParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@expermental", + "content": [] + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1120, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1142, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1143, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1122, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1144, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1125, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1143, 1144] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1120, + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1132, + "name": "AuthMFAAdminDeleteFactorResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1158, + "name": "listFactors", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], + "signatures": [ + { + "id": 1159, + "name": "listFactors", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] + }, + "parameters": [ + { + "id": 1160, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1154, + "name": "AuthMFAAdminListFactorsParams", + "dereferenced": { + "id": 1154, + "name": "AuthMFAAdminListFactorsParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@expermental", + "content": [] + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1144, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1156, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1156] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1144, + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1145, + "name": "AuthMFAAdminListFactorsResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [1161, 1158] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1154, + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" + } + ] + } + } + }, + { + "id": 44, + "name": "createUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 160, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L160" + } + ], + "signatures": [ + { + "id": 45, + "name": "createUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] + }, + "parameters": [ + { + "id": 46, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 787, + "name": "AdminUserAttributes", + "dereferenced": { + "id": 787, + "name": "AdminUserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 789, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 792, + "name": "ban_duration", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 447, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 799, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 372, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.email" + } + }, + { + "id": 790, + "name": "email_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 428, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 795, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 797, + "name": "nonce", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 796, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.password" + } + }, + { + "id": 794, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 465, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 798, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 377, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.phone" + } + }, + { + "id": 791, + "name": "phone_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 793, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 456, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 788, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 411, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" + } + ], + "extendedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 781, + "name": "UserAttributes" + }, + { + "type": "literal", + "value": "data" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 704, + "name": "UserResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 68, + "name": "deleteUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 280, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L280" + } + ], + "signatures": [ + { + "id": 69, + "name": "deleteUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a user. Requires a " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key." + } + ] + }, + "parameters": [ + { + "id": 70, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user id you want to remove." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 71, + "name": "shouldSoftDelete", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 704, + "name": "UserResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 41, + "name": "generateLink", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 126, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L126" + } + ], + "signatures": [ + { + "id": 42, + "name": "generateLink", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generates email links and OTPs to be sent via a custom email provider." + } + ] + }, + "parameters": [ + { + "id": 43, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1012, + "name": "GenerateLinkParams", + "dereferenced": { + "id": 1012, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 856, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 987, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 813, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 988, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 990, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 815, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 992, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 817, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1009, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "name": "Pick", + "qualifiedName": "Pick", + "package": "typescript" + } + }, + { + "id": 991, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 816, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 989, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 814, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [990, 992, 991, 989] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 813, + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" + } + ] + } + } + }, + { + "id": 993, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 820, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 994, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 996, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 823, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 997, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 824, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1009, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "name": "Pick", + "qualifiedName": "Pick", + "package": "typescript" + } + }, + { + "id": 995, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [996, 997, 995] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 820, + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" + } + ] + } + } + }, + { + "id": 998, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 827, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 999, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1001, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 830, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1002, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 831, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1009, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "name": "Pick", + "qualifiedName": "Pick", + "package": "typescript" + } + }, + { + "id": 1000, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 828, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1001, 1002, 1000] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 827, + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" + } + ] + } + } + }, + { + "id": 1003, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 834, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1004, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1006, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 837, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1007, + "name": "newEmail", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 841, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1008, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 842, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1009, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "name": "Pick", + "qualifiedName": "Pick", + "package": "typescript" + } + }, + { + "id": 1005, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 835, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1006, 1007, 1008, 1005] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 834, + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" + } + ] + } + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1013, + "name": "GenerateLinkResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 61, + "name": "getUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 229, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L229" + } + ], + "signatures": [ + { + "id": 62, + "name": "getUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get user by id." + } + ] + }, + "parameters": [ + { + "id": 63, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 704, + "name": "UserResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 34, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 93, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L93" + } + ], + "signatures": [ + { + "id": 35, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sends an invite link to an email address." + } + ] + }, + "parameters": [ + { + "id": 36, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 37, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional options to be included when inviting." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 38, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 39, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store additional metadata about the user. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.user_metadata`" + }, + { + "kind": "text", + "text": " column." + } + ] + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 97, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L97" + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 40, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + } + ] + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 100, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L100" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [39, 40] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 95, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L95" + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 704, + "name": "UserResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 47, + "name": "listUsers", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 182, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L182" + } + ], + "signatures": [ + { + "id": 48, + "name": "listUsers", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] + }, + "parameters": [ + { + "id": 49, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object which supports " + }, + { + "kind": "code", + "text": "`page`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`perPage`" + }, + { + "kind": "text", + "text": " as numbers, to alter the paginated results." + } + ] + }, + "type": { + "type": "reference", + "id": 1184, + "name": "PageParams", + "dereferenced": { + "id": 1184, + "name": "PageParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1213, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1185, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1186, + "name": "page", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1215, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1187, + "name": "perPage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1217, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [1186, 1187] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1213, + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 50, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 51, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 52, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 54, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 53, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 755, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [54, 53] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ] + } + }, + { + "type": "reference", + "id": 1177, + "name": "Pagination" + } + ] + } + }, + { + "id": 55, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 59, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [51, 55] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 56, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 57, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 58, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 59, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } + ], + "type": { + "type": "tuple" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [59] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } + ] + } + } + }, + { + "id": 60, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } + ], + "type": { + "type": "reference", + "id": 1275, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [57, 60] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } + ] + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 27, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 62, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L62" + } + ], + "signatures": [ + { + "id": 28, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Removes a logged-in session." + } + ] + }, + "parameters": [ + { + "id": 29, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A valid, logged-in JWT." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 30, + "name": "scope", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The logout sope." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "global" + }, + { + "type": "literal", + "value": "local" + }, + { + "type": "literal", + "value": "others" + } + ] + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 31, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 32, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 33, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 1275, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [32, 33] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } + ] + } + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 64, + "name": "updateUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 253, + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L253" + } + ], + "signatures": [ + { + "id": 65, + "name": "updateUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Updates the user data." + } + ] + }, + "parameters": [ + { + "id": 66, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 67, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] + }, + "type": { + "type": "reference", + "id": 787, + "name": "AdminUserAttributes", + "dereferenced": { + "id": 787, + "name": "AdminUserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 789, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 792, + "name": "ban_duration", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 447, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 799, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 372, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.email" + } + }, + { + "id": 790, + "name": "email_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 428, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 795, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 797, + "name": "nonce", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.nonce" + } + }, + { + "id": 796, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.password" + } + }, + { + "id": 794, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 465, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 798, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 377, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.phone" + } + }, + { + "id": 791, + "name": "phone_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 793, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 456, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 788, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 411, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" + } + ], + "extendedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 781, + "name": "UserAttributes" + }, + { + "type": "literal", + "value": "data" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 704, + "name": "UserResponse" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [2] + }, + { + "title": "Properties", + "children": [16] + }, + { + "title": "Methods", + "children": [44, 68, 41, 61, 34, 47, 27, 64] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 27, + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L27" + } + ] + }, + { + "id": 78, + "name": "GoTrueClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 80, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 240, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L240" + } + ], + "signatures": [ + { + "id": 81, + "name": "new GoTrueClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] + }, + "parameters": [ + { + "id": 82, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 584, + "name": "GoTrueClientOptions", + "dereferenced": { + "id": 584, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 585, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 593, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L70" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 599, + "name": "debug", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reflection", + "declaration": { + "id": 600, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" + } + ], + "signatures": [ + { + "id": 601, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 602, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { "id": 603, "name": "args", "kind": 32768, @@ -13389,7 +17480,8 @@ { "fileName": "src/lib/types.ts", "line": 68, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L68" } ], "type": { @@ -13409,7 +17501,8 @@ { "fileName": "src/lib/types.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L84" } ], "type": { @@ -13429,15 +17522,16 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L86" } ], "type": { "type": "reference", - "id": 861, + "id": 863, "name": "AuthFlowType", "dereferenced": { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -13446,7 +17540,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -13474,19 +17569,20 @@ "isOptional": true }, "comment": { - "shortText": "Set to \"true\" if there is a custom authorization header set globally.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Set to \"true\" if there is a custom authorization header set globally." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L99" } ], "type": { @@ -13506,7 +17602,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "type": { @@ -13521,7 +17618,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "indexSignature": { @@ -13559,19 +17657,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L94" } ], "type": { @@ -13588,7 +17687,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -13603,7 +17703,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -13614,13 +17715,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -13639,7 +17748,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -13653,7 +17767,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -13667,7 +17794,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -13681,7 +17813,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -13700,9 +17833,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13719,9 +17852,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13742,7 +17875,8 @@ { "fileName": "src/lib/types.ts", "line": 72, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L72" } ], "type": { @@ -13762,15 +17896,16 @@ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L74" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -13779,7 +17914,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -13793,9 +17929,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -13815,9 +17951,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -13825,14 +17961,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -13840,13 +17976,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -13858,15 +18008,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -13888,7 +18038,8 @@ { "fileName": "src/lib/types.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L66" } ], "type": { @@ -13908,7 +18059,8 @@ { "fileName": "src/lib/types.ts", "line": 62, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L62" } ], "type": { @@ -13925,28 +18077,68 @@ "isOptional": true }, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, `storage` will only store a JSON object containing the access and refresh token and some adjacent metadata, while `userStorage` will only contain the user object under the key `storageKey + '-user'`.", - "text": "When this option is set and cookie storage is used, `getSession()` and other functions that load a session from the cookie store might not return back a user. It's very important to always use `getUser()` to fetch a user object in those scenarios.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " + }, + { + "kind": "code", + "text": "`storage`" + }, + { + "kind": "text", + "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " + }, + { + "kind": "code", + "text": "`userStorage`" + }, + { + "kind": "text", + "text": " will only contain the user object under the key " + }, + { + "kind": "code", + "text": "`storageKey + '-user'`" + }, + { + "kind": "text", + "text": ".\n\nWhen this option is set and cookie storage is used, " + }, + { + "kind": "code", + "text": "`getSession()`" + }, + { + "kind": "text", + "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " + }, + { + "kind": "code", + "text": "`getUser()`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " to fetch a user object in those scenarios." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L82" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -13955,7 +18147,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -13969,9 +18162,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -13991,9 +18184,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -14001,14 +18194,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -14016,13 +18209,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -14034,15 +18241,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -14056,7 +18263,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 593, 599, 592, 597, 598, 605, 587, 604, 594, 595, 591, 586, 596 ] @@ -14066,7 +18272,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ] } @@ -14090,13 +18297,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + "summary": [ + { + "kind": "text", + "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 167, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L167" } ], "type": { @@ -14120,7 +18333,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L37" } ], "signatures": [ @@ -14158,7 +18372,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 46, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L46" } ], "type": { @@ -14169,6 +18384,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -14188,15 +18410,15 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } @@ -14211,9 +18433,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -14222,14 +18444,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -14248,7 +18470,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" } ], "type": { @@ -14259,6 +18482,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -14295,7 +18526,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L42" } ], "type": { @@ -14307,9 +18539,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [11, 7, 6] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 41, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L41" + } ] } } @@ -14330,83 +18569,115 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains all MFA administration methods." + "summary": [ + { + "kind": "text", + "text": "Contains all MFA administration methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L29" } ], "type": { "type": "reference", - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -14414,32 +18685,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -14448,19 +18726,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -14472,15 +18756,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } @@ -14494,55 +18778,69 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -14550,32 +18848,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -14587,15 +18892,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } @@ -14609,13 +18914,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -14624,15 +18929,15 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] } @@ -14648,7 +18953,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L160" } ], "signatures": [ @@ -14659,7 +18965,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -14688,14 +19007,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -14712,14 +19052,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -14736,13 +19081,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -14763,14 +19114,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -14787,14 +19143,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -14811,14 +19188,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -14839,13 +19221,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -14866,14 +19254,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -14890,13 +19291,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -14917,14 +19324,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -14941,14 +19353,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -14965,14 +19414,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -14984,7 +19454,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 ] @@ -14994,7 +19463,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -15011,9 +19481,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -15029,9 +19499,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15046,7 +19516,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 280, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L280" } ], "signatures": [ @@ -15057,7 +19528,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key." + "summary": [ + { + "kind": "text", + "text": "Delete a user. Requires a " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key." + } + ] }, "parameters": [ { @@ -15067,7 +19551,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user id you want to remove." + "summary": [ + { + "kind": "text", + "text": "The user id you want to remove." + } + ] }, "type": { "type": "intrinsic", @@ -15081,7 +19570,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -15099,9 +19601,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15116,7 +19618,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 126, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L126" } ], "signatures": [ @@ -15127,7 +19630,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." + "summary": [ + { + "kind": "text", + "text": "Generates email links and OTPs to be sent via a custom email provider." + } + ] }, "parameters": [ { @@ -15138,10 +19646,10 @@ "flags": {}, "type": { "type": "reference", - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "dereferenced": { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15150,14 +19658,15 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { "type": "union", "types": [ { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15166,20 +19675,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -15188,7 +19698,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -15197,7 +19708,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -15208,7 +19719,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -15216,7 +19728,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15233,13 +19745,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -15248,7 +19760,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -15257,7 +19770,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -15266,7 +19779,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -15278,22 +19792,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15302,32 +19816,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -15336,7 +19857,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -15347,7 +19868,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -15355,7 +19877,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15372,13 +19894,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -15387,7 +19909,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -15408,22 +19931,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15432,32 +19955,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -15466,7 +19996,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -15477,7 +20007,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -15485,7 +20016,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15493,13 +20024,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -15508,7 +20039,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -15520,22 +20052,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15544,32 +20076,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -15578,19 +20117,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -15599,7 +20144,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -15610,7 +20155,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -15618,7 +20164,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15626,13 +20172,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -15641,7 +20187,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -15662,15 +20209,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } @@ -15687,13 +20234,13 @@ "typeArguments": [ { "type": "reference", - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15708,7 +20255,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 229, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L229" } ], "signatures": [ @@ -15719,7 +20267,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get user by id." + "summary": [ + { + "kind": "text", + "text": "Get user by id." + } + ] }, "parameters": [ { @@ -15729,7 +20282,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -15746,9 +20312,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15763,7 +20329,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 93, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L93" } ], "signatures": [ @@ -15774,7 +20341,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends an invite link to an email address." + "summary": [ + { + "kind": "text", + "text": "Sends an invite link to an email address." + } + ] }, "parameters": [ { @@ -15784,7 +20356,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -15798,7 +20375,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Additional options to be included when inviting.\n" + "summary": [ + { + "kind": "text", + "text": "Additional options to be included when inviting." + } + ] }, "type": { "type": "reflection", @@ -15818,13 +20400,27 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." + "summary": [ + { + "kind": "text", + "text": "A custom data object to store additional metadata about the user. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.user_metadata`" + }, + { + "kind": "text", + "text": " column." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L97" } ], "type": { @@ -15841,13 +20437,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L100" } ], "type": { @@ -15859,9 +20461,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [39, 40] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 95, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L95" + } ] } }, @@ -15877,9 +20486,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15894,7 +20503,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 182, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L182" } ], "signatures": [ @@ -15905,8 +20515,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -15918,14 +20540,35 @@ "isOptional": true }, "comment": { - "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" + "summary": [ + { + "kind": "text", + "text": "An object which supports " + }, + { + "kind": "code", + "text": "`page`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`perPage`" + }, + { + "kind": "text", + "text": " as numbers, to alter the paginated results." + } + ] }, "type": { "type": "reference", - "id": 1179, + "id": 1184, "name": "PageParams", "dereferenced": { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -15934,20 +20577,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -15955,13 +20599,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -15970,7 +20620,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -15978,13 +20628,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -15996,15 +20652,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } @@ -16038,7 +20694,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -16063,7 +20720,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -16081,7 +20739,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -16097,15 +20756,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [54, 53] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, { "type": "reference", - "id": 1172, + "id": 1177, "name": "Pagination" } ] @@ -16121,7 +20787,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -16133,9 +20800,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [51, 55] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, @@ -16158,7 +20832,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -16180,7 +20855,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -16191,9 +20867,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [59] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } @@ -16208,12 +20891,13 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -16221,18 +20905,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [57, 60] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16247,7 +20938,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 62, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L62" } ], "signatures": [ @@ -16258,7 +20950,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes a logged-in session." + "summary": [ + { + "kind": "text", + "text": "Removes a logged-in session." + } + ] }, "parameters": [ { @@ -16268,7 +20965,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A valid, logged-in JWT." + "summary": [ + { + "kind": "text", + "text": "A valid, logged-in JWT." + } + ] }, "type": { "type": "intrinsic", @@ -16282,7 +20984,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The logout sope.\n" + "summary": [ + { + "kind": "text", + "text": "The logout sope." + } + ] }, "type": { "type": "union", @@ -16326,7 +21033,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -16344,7 +21052,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -16356,7 +21065,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -16366,16 +21075,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [32, 33] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16390,7 +21106,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 253, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L253" } ], "signatures": [ @@ -16401,7 +21118,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "summary": [ + { + "kind": "text", + "text": "Updates the user data." + } + ] }, "parameters": [ { @@ -16422,7 +21144,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "reference", @@ -16444,14 +21179,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -16468,14 +21224,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -16492,13 +21253,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -16519,14 +21286,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -16543,14 +21315,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -16567,14 +21360,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -16595,13 +21393,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -16622,14 +21426,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -16646,13 +21463,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -16673,14 +21496,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -16697,14 +21525,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -16721,14 +21586,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -16740,7 +21626,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 ] @@ -16750,7 +21635,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -16767,9 +21653,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -16785,9 +21671,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16796,17 +21682,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [2] }, { "title": "Properties", - "kind": 1024, "children": [16] }, { "title": "Methods", - "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], @@ -16814,7 +21697,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L27" } ] } @@ -16827,58 +21711,82 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the MFA methods." + "summary": [ + { + "kind": "text", + "text": "Namespace for the MFA methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L171" } ], "type": { "type": "reference", - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "dereferenced": { - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication API." + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication API." + } + ] }, "children": [ { - "id": 1111, + "id": 1116, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1058, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1058" + } + ], "signatures": [ { - "id": 1112, + "id": 1117, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + "summary": [ + { + "kind": "text", + "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + } + ] }, "parameters": [ { - "id": 1113, + "id": 1118, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "dereferenced": { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -16887,20 +21795,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -16908,13 +21817,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -16932,19 +21847,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -16956,15 +21877,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } @@ -16978,46 +21899,59 @@ "typeArguments": [ { "type": "reference", - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1120, + "id": 1125, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1076, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1076" + } + ], "signatures": [ { - "id": 1121, + "id": 1126, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1122, + "id": 1127, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17026,32 +21960,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -17060,19 +22001,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -17084,15 +22031,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } @@ -17106,47 +22053,87 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1104, + "id": 1109, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1050, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1050" + }, + { + "fileName": "src/lib/types.ts", + "line": 1051, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1051" + }, + { + "fileName": "src/lib/types.ts", + "line": 1052, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1052" + } + ], "signatures": [ { - "id": 1105, + "id": 1110, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + "summary": [ + { + "kind": "text", + "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " + }, + { + "kind": "code", + "text": "`unverified`" + }, + { + "kind": "text", + "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 1106, + "id": 1111, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -17155,32 +22142,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -17189,7 +22183,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17197,13 +22191,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -17212,7 +22212,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -17220,13 +22220,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -17238,15 +22244,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } @@ -17260,34 +22266,34 @@ "typeArguments": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1107, + "id": 1112, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1108, + "id": 1113, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -17296,32 +22302,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -17330,7 +22343,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17338,13 +22351,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -17353,19 +22372,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -17377,15 +22402,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -17399,34 +22424,34 @@ "typeArguments": [ { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1109, + "id": 1114, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1115, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "dereferenced": { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17435,14 +22460,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -17451,32 +22477,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -17485,7 +22518,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17493,13 +22526,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -17508,7 +22547,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -17516,13 +22555,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -17534,22 +22579,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -17558,32 +22603,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -17592,7 +22644,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17600,13 +22652,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -17615,19 +22673,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -17639,15 +22703,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -17664,77 +22728,161 @@ "typeArguments": [ { "type": "reference", - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1125, + "id": 1130, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1101, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1101" + } + ], "signatures": [ { - "id": 1126, + "id": 1131, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + "summary": [ + { + "kind": "text", + "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " + }, + { + "kind": "code", + "text": "`aal1`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1123, + "id": 1128, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1086, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1086" + } + ], "signatures": [ { - "id": 1124, + "id": 1129, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, + "kind": "text", + "text": "Returns the list of MFA factors enabled for this user." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getUser", + "target": 295 + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -17743,46 +22891,75 @@ "typeArguments": [ { "type": "reference", - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1117, + "id": 1122, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1070, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1070" + } + ], "signatures": [ { - "id": 1118, + "id": 1123, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + "summary": [ + { + "kind": "text", + "text": "Unenroll removes a MFA factor.\nA user has to have an " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " authenticator level in order to unenroll a " + }, + { + "kind": "code", + "text": "`verified`" + }, + { + "kind": "text", + "text": " factor." + } + ] }, "parameters": [ { - "id": 1119, + "id": 1124, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "dereferenced": { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17791,32 +22968,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -17828,15 +23012,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } @@ -17850,46 +23034,59 @@ "typeArguments": [ { "type": "reference", - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1114, + "id": 1119, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1064, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1064" + } + ], "signatures": [ { - "id": 1115, + "id": 1120, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1116, + "id": 1121, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "dereferenced": { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17898,32 +23095,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -17932,19 +23136,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -17953,19 +23163,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -17977,15 +23193,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } @@ -17999,13 +23215,13 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18014,15 +23230,15 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1111, 1120, 1104, 1125, 1123, 1117, 1114] + "children": [1116, 1125, 1109, 1130, 1128, 1122, 1119] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1039" } ] } @@ -18038,7 +23254,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 651, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L651" } ], "signatures": [ @@ -18049,7 +23266,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + } + ] }, "parameters": [ { @@ -18073,9 +23295,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18090,7 +23312,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3181" } ], "signatures": [ @@ -18101,8 +23324,40 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n`/.well-known/jwks.json` which is often cached, resulting in significantly\nfaster responses. Prefer this method over {@link #getUser} which always\nsends a request to the Auth server for each JWT.", - "text": "If the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to {@link\n#getUser}) to verify the JWT.\n" + "summary": [ + { + "kind": "text", + "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" + }, + { + "kind": "code", + "text": "`/.well-known/jwks.json`" + }, + { + "kind": "text", + "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": ") to verify the JWT." + } + ] }, "parameters": [ { @@ -18114,7 +23369,22 @@ "isOptional": true }, "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\n can obtain from {@link #getSession}." + "summary": [ + { + "kind": "text", + "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getSession", + "target": 0 + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -18128,7 +23398,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Various additional options that allow you to customize the\n behavior of this method.\n" + "summary": [ + { + "kind": "text", + "text": "Various additional options that allow you to customize the\n behavior of this method." + } + ] }, "type": { "type": "reflection", @@ -18148,13 +23423,35 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` the `exp` claim will not be validated against the current time." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " the " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " claim will not be validated against the current time." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3190, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3190" } ], "type": { @@ -18171,13 +23468,19 @@ "isOptional": true }, "comment": { - "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + "summary": [ + { + "kind": "text", + "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { @@ -18199,14 +23502,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -18215,9 +23519,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [532] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3193, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" + } ] } } @@ -18231,10 +23542,16 @@ "isOptional": true }, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Please use options.jwks instead.\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Please use options.jwks instead." + } + ] } ] }, @@ -18242,14 +23559,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3187" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -18258,9 +23576,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [529, 530, 528] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3183, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3183" + } ] } }, @@ -18292,7 +23617,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { @@ -18314,12 +23640,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1239, + "id": 1244, "name": "JwtPayload" } }, @@ -18333,12 +23660,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 36 + "character": 36, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1224, + "id": 1229, "name": "JwtHeader" } }, @@ -18352,23 +23680,31 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 55 + "character": 55, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, "children": [536, 537, 538] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3197, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" + } ] } } @@ -18383,7 +23719,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3198, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3198" } ], "type": { @@ -18395,9 +23732,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [534, 539] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3196, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3196" + } ] } }, @@ -18420,7 +23764,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { @@ -18438,12 +23783,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -18451,9 +23797,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [541, 542] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3200, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" + } ] } }, @@ -18476,7 +23829,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -18494,7 +23848,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -18506,18 +23861,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [544, 545] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3201, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18532,7 +23894,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1355, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1355" } ], "signatures": [ @@ -18543,8 +23906,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session, refreshing it if necessary.", - "text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use {@link #getUser()} instead.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser()", + "target": 0 + }, + { + "kind": "text", + "text": " instead." + } + ] }, "type": { "type": "reference", @@ -18571,7 +23948,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1448, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" } ], "type": { @@ -18593,7 +23971,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1449, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1449" } ], "type": { @@ -18606,9 +23985,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [237] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1448, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" + } ] } } @@ -18623,7 +24009,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1451, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1451" } ], "type": { @@ -18635,9 +24022,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [235, 238] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1447, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1447" + } ] } }, @@ -18660,7 +24054,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1454, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" } ], "type": { @@ -18682,7 +24077,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1455, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1455" } ], "type": { @@ -18694,9 +24090,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [242] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1454, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" + } ] } } @@ -18711,12 +24114,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 1457, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1457" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -18724,9 +24128,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [240, 243] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1453, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1453" + } ] } }, @@ -18749,7 +24160,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1460, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" } ], "type": { @@ -18771,7 +24183,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1461, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1461" } ], "type": { @@ -18783,9 +24196,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [247] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1460, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" + } ] } } @@ -18800,7 +24220,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1463, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1463" } ], "type": { @@ -18812,18 +24233,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [245, 248] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1459, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1459" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18838,7 +24266,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1599, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1599" } ], "signatures": [ @@ -18849,7 +24278,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + "summary": [ + { + "kind": "text", + "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + } + ] }, "parameters": [ { @@ -18861,7 +24295,12 @@ "isOptional": true }, "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\n" + "summary": [ + { + "kind": "text", + "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." + } + ] }, "type": { "type": "intrinsic", @@ -18878,9 +24317,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18895,7 +24334,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2157, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2157" } ], "signatures": [ @@ -18906,7 +24346,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets all the identities linked to a user." + "summary": [ + { + "kind": "text", + "text": "Gets all the identities linked to a user." + } + ] }, "type": { "type": "reference", @@ -18933,7 +24378,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" } ], "type": { @@ -18955,7 +24401,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2160, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2160" } ], "type": { @@ -18971,9 +24418,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [409] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2159, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" + } ] } } @@ -18988,7 +24442,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2162, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2162" } ], "type": { @@ -19000,9 +24455,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [407, 410] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2158, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2158" + } ] } }, @@ -19025,7 +24487,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { @@ -19043,12 +24506,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -19056,18 +24520,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [412, 413] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2164, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -19082,7 +24553,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 353, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L353" } ], "signatures": [ @@ -19093,20 +24565,25 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + "summary": [ + { + "kind": "text", + "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1162, + "id": 1167, "name": "InitializeResult" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -19121,7 +24598,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2181" } ], "signatures": [ @@ -19132,7 +24610,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -19143,10 +24626,10 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19155,20 +24638,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -19179,20 +24663,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -19200,19 +24685,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -19221,18 +24712,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -19251,7 +24743,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19259,13 +24751,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -19274,7 +24772,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -19282,13 +24780,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -19297,7 +24801,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -19305,13 +24809,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -19323,34 +24833,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -19364,13 +24880,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -19473,15 +24995,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } @@ -19499,9 +25021,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -19516,7 +25038,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2055, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2055" } ], "signatures": [ @@ -19527,7 +25050,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Receive a notification every time an auth event happens." + "summary": [ + { + "kind": "text", + "text": "Receive a notification every time an auth event happens." + } + ] }, "parameters": [ { @@ -19537,7 +25065,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\n" + "summary": [ + { + "kind": "text", + "text": "A callback function to be invoked when an auth event happens." + } + ] }, "type": { "type": "reflection", @@ -19547,6 +25080,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2056, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2056" + } + ], "signatures": [ { "id": 380, @@ -19604,9 +25145,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } ] } @@ -19635,7 +25176,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -19657,7 +25199,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -19671,201 +25214,189 @@ "kindString": "Interface", "flags": {}, "children": [ - { - "id": 801, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 802, "name": "callback", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 483, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 803, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 483, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" + } + ], + "signatures": [ { "id": 804, - "name": "event", - "kind": 32768, - "kindString": "Parameter", + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "type": { - "type": "reference", - "id": 574, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 574, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to call every time there is an event. eg: (eventName) => {}" + } + ] + }, + "parameters": [ + { + "id": 805, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 574, + "name": "AuthChangeEvent" + } + }, + { + "id": 806, + "name": "session", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], "type": { "type": "union", "types": [ { "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" + "value": null }, { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "id": 573, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } + "type": "reference", + "id": 715, + "name": "Session" } ] } } - } - }, - { - "id": 805, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, + ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 715, - "name": "Session" - } - ] + "type": "intrinsic", + "name": "void" } } - ], - "type": { - "type": "intrinsic", - "name": "void" + ] + } + } + }, + { + "id": 801, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subscriber UUID. This will be set by the client." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L479" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 806, + "id": 807, "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 487, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" } ], - "signatures": [ - { - "id": 807, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" + } + ], + "signatures": [ + { + "id": 809, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Call this to remove the listener." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [801] - }, - { - "title": "Methods", - "kind": 2048, - "children": [802, 806] + "children": [802, 801, 807] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 475, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L475" } ] } @@ -19875,9 +25406,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [386] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2058, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" + } ] } } @@ -19886,9 +25424,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [384] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2057, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2057" + } ] } } @@ -19905,7 +25450,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1271, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1271" } ], "signatures": [ @@ -19916,7 +25462,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + "summary": [ + { + "kind": "text", + "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + } + ] }, "type": { "type": "reference", @@ -19927,9 +25478,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -19944,7 +25495,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "signatures": [ @@ -19955,7 +25507,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -19967,7 +25524,12 @@ "isOptional": true }, "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session. If passed in, it must contain a refresh token." + } + ] }, "type": { "type": "reflection", @@ -19988,7 +25550,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "type": { @@ -20000,9 +25563,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [329] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1804, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" + } ] } } @@ -20017,9 +25587,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20034,7 +25604,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1306, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1306" } ], "signatures": [ @@ -20045,7 +25616,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + "summary": [ + { + "kind": "text", + "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + } + ] }, "parameters": [ { @@ -20056,10 +25632,10 @@ "flags": {}, "type": { "type": "reference", - "id": 955, + "id": 960, "name": "ResendParams", "dereferenced": { - "id": 955, + "id": 960, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -20068,7 +25644,8 @@ { "fileName": "src/lib/types.ts", "line": 769, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L769" } ], "type": { @@ -20077,14 +25654,14 @@ { "type": "reflection", "declaration": { - "id": 956, + "id": 961, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 963, "name": "email", "kind": 1024, "kindString": "Property", @@ -20093,7 +25670,8 @@ { "fileName": "src/lib/types.ts", "line": 772, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L772" } ], "type": { @@ -20102,7 +25680,7 @@ } }, { - "id": 959, + "id": 964, "name": "options", "kind": 1024, "kindString": "Property", @@ -20113,20 +25691,21 @@ { "fileName": "src/lib/types.ts", "line": 773, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ], "type": { "type": "reflection", "declaration": { - "id": 960, + "id": 965, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 962, + "id": 967, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20134,13 +25713,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L777" } ], "type": { @@ -20149,7 +25734,7 @@ } }, { - "id": 961, + "id": 966, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -20157,13 +25742,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 775, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L775" } ], "type": { @@ -20175,22 +25766,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [962, 961] + "children": [967, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 773, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ] } } }, { - "id": 957, + "id": 962, "name": "type", "kind": 1024, "kindString": "Property", @@ -20199,7 +25790,8 @@ { "fileName": "src/lib/types.ts", "line": 771, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L771" } ], "type": { @@ -20207,7 +25799,7 @@ "typeArguments": [ { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" }, { @@ -20224,24 +25816,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [958, 959, 957] + "children": [963, 964, 962] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 770, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L770" } ] } @@ -20249,14 +25841,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 966, + "id": 971, "name": "options", "kind": 1024, "kindString": "Property", @@ -20267,20 +25859,21 @@ { "fileName": "src/lib/types.ts", "line": 783, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ], "type": { "type": "reflection", "declaration": { - "id": 967, + "id": 972, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 968, + "id": 973, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20288,13 +25881,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L785" } ], "type": { @@ -20306,22 +25905,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [968] + "children": [973] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 783, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ] } } }, { - "id": 965, + "id": 970, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20330,7 +25929,8 @@ { "fileName": "src/lib/types.ts", "line": 782, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L782" } ], "type": { @@ -20339,7 +25939,7 @@ } }, { - "id": 964, + "id": 969, "name": "type", "kind": 1024, "kindString": "Property", @@ -20348,7 +25948,8 @@ { "fileName": "src/lib/types.ts", "line": 781, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L781" } ], "type": { @@ -20356,7 +25957,7 @@ "typeArguments": [ { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" }, { @@ -20373,24 +25974,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [966, 965, 964] + "children": [971, 970, 969] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 780, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L780" } ] } @@ -20410,9 +26011,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20427,7 +26028,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2111" } ], "signatures": [ @@ -20438,7 +26040,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Sends a password reset request to an email address. This method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -20448,7 +26055,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -20479,13 +26091,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2115" } ], "type": { @@ -20502,13 +26120,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL to send the user to after they click the password reset link." + "summary": [ + { + "kind": "text", + "text": "The URL to send the user to after they click the password reset link." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2114" } ], "type": { @@ -20520,9 +26144,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [396, 395] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2113, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2113" + } ] } }, @@ -20554,7 +26185,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2119" } ], "type": { @@ -20578,7 +26210,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2120, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2120" } ], "type": { @@ -20590,9 +26223,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [398, 400] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2118, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2118" + } ] } }, @@ -20615,7 +26255,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { @@ -20633,12 +26274,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -20646,18 +26288,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [402, 403] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2122, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20672,7 +26321,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1729, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" } ], "signatures": [ @@ -20683,7 +26333,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -20693,7 +26348,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The current session that minimally contains an access token and refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session that minimally contains an access token and refresh token." + } + ] }, "type": { "type": "reflection", @@ -20714,7 +26374,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1730, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1730" } ], "type": { @@ -20732,7 +26393,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1731, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1731" } ], "type": { @@ -20744,9 +26406,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [317, 318] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1729, + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" + } ] } } @@ -20761,9 +26430,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20778,7 +26447,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 456, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L456" } ], "signatures": [ @@ -20789,8 +26459,23 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new anonymous user.", - "returns": "A session where the is_anonymous claim in the access token JWT set to true\n" + "summary": [ + { + "kind": "text", + "text": "Creates a new anonymous user." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A session where the is_anonymous claim in the access token JWT set to true" + } + ] + } + ] }, "parameters": [ { @@ -20803,10 +26488,10 @@ }, "type": { "type": "reference", - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20815,20 +26500,21 @@ { "fileName": "src/lib/types.ts", "line": 490, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ], "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 812, "name": "options", "kind": 1024, "kindString": "Property", @@ -20839,20 +26525,21 @@ { "fileName": "src/lib/types.ts", "line": 491, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ], "type": { "type": "reflection", "declaration": { - "id": 811, + "id": 813, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 813, + "id": 815, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20860,13 +26547,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 499, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L499" } ], "type": { @@ -20875,7 +26568,7 @@ } }, { - "id": 812, + "id": 814, "name": "data", "kind": 1024, "kindString": "Property", @@ -20883,14 +26576,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 497, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L497" } ], "type": { @@ -20902,15 +26616,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [813, 812] + "children": [815, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 491, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ] } @@ -20920,15 +26634,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [810] + "children": [812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 490, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ] } @@ -20946,9 +26660,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20963,7 +26677,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1064, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1064" } ], "signatures": [ @@ -20974,7 +26689,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + "summary": [ + { + "kind": "text", + "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + } + ] }, "parameters": [ { @@ -20985,10 +26705,10 @@ "flags": {}, "type": { "type": "reference", - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20997,20 +26717,21 @@ { "fileName": "src/lib/types.ts", "line": 617, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ], "type": { "type": "reflection", "declaration": { - "id": 875, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 881, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -21018,13 +26739,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L623" } ], "type": { @@ -21033,7 +26768,7 @@ } }, { - "id": 880, + "id": 882, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -21041,13 +26776,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L625" } ], "type": { @@ -21056,7 +26805,7 @@ } }, { - "id": 881, + "id": 883, "name": "options", "kind": 1024, "kindString": "Property", @@ -21067,20 +26816,21 @@ { "fileName": "src/lib/types.ts", "line": 626, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ], "type": { "type": "reflection", "declaration": { - "id": 882, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 883, + "id": 885, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21088,13 +26838,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 628, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L628" } ], "type": { @@ -21106,34 +26862,96 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [883] + "children": [885] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 626, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ] } } }, { - "id": 876, + "id": 878, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)." + "summary": [ + { + "kind": "text", + "text": "Provider name or OIDC " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " value identifying which provider should be used to verify the provided token. Supported names: " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`apple`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`azure`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`facebook`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`kakao`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`keycloak`" + }, + { + "kind": "text", + "text": " (deprecated)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 619, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ], "type": { @@ -21169,7 +26987,7 @@ { "type": "reflection", "declaration": { - "id": 877, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -21178,7 +26996,8 @@ { "fileName": "src/lib/types.ts", "line": 619, - "character": 76 + "character": 76, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ] } @@ -21189,19 +27008,57 @@ } }, { - "id": 878, + "id": 880, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." + "summary": [ + { + "kind": "text", + "text": "OIDC ID token issued by the specified provider. The " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " which require that you provide an " + }, + { + "kind": "code", + "text": "`access_token`" + }, + { + "kind": "text", + "text": " value to be accepted properly. If the token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim you must supply the nonce used to obtain the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 621, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L621" } ], "type": { @@ -21213,15 +27070,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [879, 880, 881, 876, 878] + "children": [881, 882, 883, 878, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 617, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ] } @@ -21239,9 +27096,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -21256,7 +27113,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 639, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L639" } ], "signatures": [ @@ -21267,7 +27125,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -21278,10 +27141,10 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -21290,20 +27153,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -21314,20 +27178,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -21335,19 +27200,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -21356,18 +27227,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -21386,7 +27258,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -21394,13 +27266,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -21409,7 +27287,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -21417,13 +27295,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -21432,7 +27316,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -21440,13 +27324,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -21458,34 +27348,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -21499,13 +27395,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -21608,15 +27510,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } @@ -21634,9 +27536,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -21651,7 +27553,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1119" } ], "signatures": [ @@ -21662,8 +27565,28 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).", - "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" + "summary": [ + { + "kind": "text", + "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " + }, + { + "kind": "code", + "text": "`{{ .ConfirmationURL }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " + }, + { + "kind": "code", + "text": "`{{ .Token }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed." + } + ] }, "parameters": [ { @@ -21674,10 +27597,10 @@ "flags": {}, "type": { "type": "reference", - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -21686,7 +27609,8 @@ { "fileName": "src/lib/types.ts", "line": 563, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L563" } ], "type": { @@ -21695,26 +27619,32 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L566" } ], "type": { @@ -21723,7 +27653,7 @@ } }, { - "id": 847, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -21734,20 +27664,21 @@ { "fileName": "src/lib/types.ts", "line": 567, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ], "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 852, + "id": 854, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21755,13 +27686,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 579, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L579" } ], "type": { @@ -21770,7 +27707,7 @@ } }, { - "id": 851, + "id": 853, "name": "data", "kind": 1024, "kindString": "Property", @@ -21778,14 +27715,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L577" } ], "type": { @@ -21794,7 +27752,7 @@ } }, { - "id": 849, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -21802,13 +27760,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L569" } ], "type": { @@ -21817,7 +27781,7 @@ } }, { - "id": 850, + "id": 852, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -21825,13 +27789,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L571" } ], "type": { @@ -21843,15 +27813,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [852, 851, 849, 850] + "children": [854, 853, 851, 852] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 567, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ] } @@ -21861,15 +27831,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [846, 847] + "children": [848, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 564, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L564" } ] } @@ -21877,14 +27847,14 @@ { "type": "reflection", "declaration": { - "id": 853, + "id": 855, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 855, + "id": 857, "name": "options", "kind": 1024, "kindString": "Property", @@ -21895,20 +27865,21 @@ { "fileName": "src/lib/types.ts", "line": 585, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ], "type": { "type": "reflection", "declaration": { - "id": 856, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 861, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21916,13 +27887,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 595, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L595" } ], "type": { @@ -21931,7 +27908,7 @@ } }, { - "id": 860, + "id": 862, "name": "channel", "kind": 1024, "kindString": "Property", @@ -21939,13 +27916,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 597, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L597" } ], "type": { @@ -21963,7 +27946,7 @@ } }, { - "id": 858, + "id": 860, "name": "data", "kind": 1024, "kindString": "Property", @@ -21971,14 +27954,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 593, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L593" } ], "type": { @@ -21987,7 +27991,7 @@ } }, { - "id": 857, + "id": 859, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -21995,13 +27999,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L587" } ], "type": { @@ -22013,34 +28023,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [859, 860, 858, 857] + "children": [861, 862, 860, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 585, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ] } } }, { - "id": 854, + "id": 856, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 584, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L584" } ], "type": { @@ -22052,15 +28068,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [855, 854] + "children": [857, 856] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 582, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L582" } ] } @@ -22080,9 +28096,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22097,7 +28113,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 576, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L576" } ], "signatures": [ @@ -22108,8 +28125,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.", - "text": "Be aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login.\n" + "summary": [ + { + "kind": "text", + "text": "Log in an existing user with an email and password or phone and password.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." + } + ] }, "parameters": [ { @@ -22120,10 +28141,10 @@ "flags": {}, "type": { "type": "reference", - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -22132,7 +28153,8 @@ { "fileName": "src/lib/types.ts", "line": 541, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L541" } ], "type": { @@ -22141,26 +28163,32 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 835, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 544, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L544" } ], "type": { @@ -22169,7 +28197,7 @@ } }, { - "id": 835, + "id": 837, "name": "options", "kind": 1024, "kindString": "Property", @@ -22180,20 +28208,21 @@ { "fileName": "src/lib/types.ts", "line": 547, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ], "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22201,13 +28230,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L549" } ], "type": { @@ -22219,34 +28254,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [837] + "children": [839] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 547, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ] } } }, { - "id": 834, + "id": 836, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 546, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L546" } ], "type": { @@ -22258,15 +28299,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [833, 835, 834] + "children": [835, 837, 836] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 542, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L542" } ] } @@ -22274,14 +28315,14 @@ { "type": "reflection", "declaration": { - "id": 838, + "id": 840, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 843, "name": "options", "kind": 1024, "kindString": "Property", @@ -22292,20 +28333,21 @@ { "fileName": "src/lib/types.ts", "line": 557, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 843, + "id": 845, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22313,13 +28355,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L559" } ], "type": { @@ -22331,34 +28379,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [843] + "children": [845] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 557, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ] } } }, { - "id": 840, + "id": 842, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 556, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L556" } ], "type": { @@ -22367,19 +28421,25 @@ } }, { - "id": 839, + "id": 841, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 554, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L554" } ], "type": { @@ -22391,15 +28451,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [841, 840, 839] + "children": [843, 842, 841] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 552, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L552" } ] } @@ -22419,9 +28479,9 @@ "name": "AuthTokenResponsePassword" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22436,7 +28496,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1233, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1233" } ], "signatures": [ @@ -22447,8 +28508,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", - "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n" + "summary": [ + { + "kind": "text", + "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." + } + ] }, "parameters": [ { @@ -22459,10 +28524,10 @@ "flags": {}, "type": { "type": "reference", - "id": 969, + "id": 974, "name": "SignInWithSSO", "dereferenced": { - "id": 969, + "id": 974, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -22471,7 +28536,8 @@ { "fileName": "src/lib/types.ts", "line": 789, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L789" } ], "type": { @@ -22480,14 +28546,14 @@ { "type": "reflection", "declaration": { - "id": 970, + "id": 975, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 972, + "id": 977, "name": "options", "kind": 1024, "kindString": "Property", @@ -22498,20 +28564,21 @@ { "fileName": "src/lib/types.ts", "line": 794, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ], "type": { "type": "reflection", "declaration": { - "id": 973, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 975, + "id": 980, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22519,13 +28586,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 798, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L798" } ], "type": { @@ -22534,7 +28607,7 @@ } }, { - "id": 974, + "id": 979, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -22542,13 +28615,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L796" } ], "type": { @@ -22560,34 +28639,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [975, 974] + "children": [980, 979] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ] } } }, { - "id": 971, + "id": 976, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." + "summary": [ + { + "kind": "text", + "text": "UUID of the SSO provider to invoke single-sign on to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 792, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L792" } ], "type": { @@ -22599,15 +28684,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [972, 971] + "children": [977, 976] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 790, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L790" } ] } @@ -22615,26 +28700,32 @@ { "type": "reflection", "declaration": { - "id": 976, + "id": 981, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 977, + "id": 982, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." + "summary": [ + { + "kind": "text", + "text": "Domain name of the organization for which to invoke single-sign on." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 803, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L803" } ], "type": { @@ -22643,7 +28734,7 @@ } }, { - "id": 978, + "id": 983, "name": "options", "kind": 1024, "kindString": "Property", @@ -22654,20 +28745,21 @@ { "fileName": "src/lib/types.ts", "line": 805, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ], "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 984, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 981, + "id": 986, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22675,13 +28767,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 809, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L809" } ], "type": { @@ -22690,7 +28788,7 @@ } }, { - "id": 980, + "id": 985, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -22698,13 +28796,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L807" } ], "type": { @@ -22716,15 +28820,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [981, 980] + "children": [986, 985] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 805, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ] } @@ -22734,15 +28838,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [977, 978] + "children": [982, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 801, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L801" } ] } @@ -22762,9 +28866,9 @@ "name": "SSOResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22779,7 +28883,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 666, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L666" } ], "signatures": [ @@ -22790,11 +28895,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side.", - "tags": [ + "summary": [ { - "tag": "reference", - "text": "https://eips.ethereum.org/EIPS/eip-4361\n" + "kind": "text", + "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." + } + ], + "blockTags": [ + { + "tag": "@reference", + "content": [ + { + "kind": "text", + "text": "https://eips.ethereum.org/EIPS/eip-4361" + } + ] } ] }, @@ -22807,10 +28922,10 @@ "flags": {}, "type": { "type": "reference", - "id": 932, + "id": 937, "name": "Web3Credentials", "dereferenced": { - "id": 932, + "id": 937, "name": "Web3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -22819,14 +28934,15 @@ { "fileName": "src/lib/types.ts", "line": 717, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L717" } ], "type": { "type": "union", "types": [ { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -22835,7 +28951,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -22844,14 +28961,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -22860,7 +28977,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -22869,7 +28987,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -22880,20 +28998,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22901,13 +29020,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -22916,7 +29041,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -22927,7 +29052,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -22966,18 +29092,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -22985,13 +29111,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -23003,22 +29135,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -23026,13 +29158,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -23041,7 +29179,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -23049,18 +29187,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -23068,15 +29220,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -23084,14 +29236,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -23100,7 +29252,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -23109,19 +29262,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -23130,7 +29313,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -23141,20 +29324,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23162,13 +29346,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -23180,56 +29370,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -23238,7 +29434,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -23247,7 +29443,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -23256,14 +29453,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -23272,7 +29469,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -23281,7 +29479,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -23292,20 +29490,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23313,13 +29512,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -23328,7 +29533,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -23339,7 +29544,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -23374,18 +29580,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -23393,13 +29599,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -23411,22 +29623,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -23434,13 +29646,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -23449,7 +29667,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -23457,18 +29675,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -23476,15 +29708,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -23492,14 +29724,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -23508,7 +29740,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -23517,19 +29750,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -23538,7 +29801,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -23549,20 +29812,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23570,13 +29834,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -23588,34 +29858,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -23627,15 +29903,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -23674,7 +29950,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -23696,7 +29973,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -23715,7 +29993,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -23728,9 +30007,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [166, 167] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 668, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" + } ] } } @@ -23745,7 +30031,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 669, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L669" } ], "type": { @@ -23757,9 +30044,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [164, 168] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 667, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L667" + } ] } }, @@ -23782,7 +30076,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -23804,7 +30099,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -23822,7 +30118,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -23834,9 +30131,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [172, 173] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } @@ -23851,12 +30155,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -23864,18 +30169,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [170, 174] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -23890,7 +30202,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "signatures": [ @@ -23901,8 +30214,52 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n" + "summary": [ + { + "kind": "text", + "text": "Inside a browser context, " + }, + { + "kind": "code", + "text": "`signOut()`" + }, + { + "kind": "text", + "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " + }, + { + "kind": "code", + "text": "`\"SIGNED_OUT\"`" + }, + { + "kind": "text", + "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " + }, + { + "kind": "code", + "text": "`auth.api.signOut(JWT: string)`" + }, + { + "kind": "text", + "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " + }, + { + "kind": "code", + "text": "`others`" + }, + { + "kind": "text", + "text": " scope, no " + }, + { + "kind": "code", + "text": "`SIGNED_OUT`" + }, + { + "kind": "text", + "text": " event is fired!" + } + ] }, "parameters": [ { @@ -23913,10 +30270,10 @@ "flags": {}, "type": { "type": "reference", - "id": 1183, + "id": 1188, "name": "SignOut", "dereferenced": { - "id": 1183, + "id": 1188, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -23925,20 +30282,21 @@ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ], "type": { "type": "reflection", "declaration": { - "id": 1184, + "id": 1189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1185, + "id": 1190, "name": "scope", "kind": 1024, "kindString": "Property", @@ -23946,13 +30304,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + "summary": [ + { + "kind": "text", + "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1231, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1231" } ], "type": { @@ -23977,15 +30341,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1185] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ] } @@ -24017,7 +30381,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 67 + "character": 67, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "type": { @@ -24029,7 +30394,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -24039,16 +30404,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [370] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2011, + "character": 65, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -24063,7 +30435,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 499, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L499" } ], "signatures": [ @@ -24074,9 +30447,32 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "Be aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\n", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A logged-in session if the server has \"autoconfirm\" ON" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A user if the server has \"autoconfirm\" OFF" + } + ] + } + ] }, "parameters": [ { @@ -24087,10 +30483,10 @@ "flags": {}, "type": { "type": "reference", - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -24099,7 +30495,8 @@ { "fileName": "src/lib/types.ts", "line": 503, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L503" } ], "type": { @@ -24108,26 +30505,32 @@ { "type": "reflection", "declaration": { - "id": 815, + "id": 817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 818, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 506, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L506" } ], "type": { @@ -24136,7 +30539,7 @@ } }, { - "id": 818, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -24147,20 +30550,21 @@ { "fileName": "src/lib/types.ts", "line": 509, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ], "type": { "type": "reflection", "declaration": { - "id": 819, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 822, + "id": 824, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -24168,13 +30572,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 519, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L519" } ], "type": { @@ -24183,7 +30593,7 @@ } }, { - "id": 821, + "id": 823, "name": "data", "kind": 1024, "kindString": "Property", @@ -24191,14 +30601,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 517, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L517" } ], "type": { @@ -24207,7 +30638,7 @@ } }, { - "id": 820, + "id": 822, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -24215,13 +30646,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L511" } ], "type": { @@ -24233,34 +30670,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [822, 821, 820] + "children": [824, 823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 509, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ] } } }, { - "id": 817, + "id": 819, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L508" } ], "type": { @@ -24272,15 +30715,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [816, 818, 817] + "children": [818, 820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 504, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L504" } ] } @@ -24288,14 +30731,14 @@ { "type": "reflection", "declaration": { - "id": 823, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 826, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -24306,20 +30749,21 @@ { "fileName": "src/lib/types.ts", "line": 527, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -24327,13 +30771,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L535" } ], "type": { @@ -24342,7 +30792,7 @@ } }, { - "id": 830, + "id": 832, "name": "channel", "kind": 1024, "kindString": "Property", @@ -24350,13 +30800,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 537, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L537" } ], "type": { @@ -24374,7 +30830,7 @@ } }, { - "id": 828, + "id": 830, "name": "data", "kind": 1024, "kindString": "Property", @@ -24382,14 +30838,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L533" } ], "type": { @@ -24401,34 +30878,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [829, 830, 828] + "children": [831, 832, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 527, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ] } } }, { - "id": 825, + "id": 827, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 526, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L526" } ], "type": { @@ -24437,19 +30920,25 @@ } }, { - "id": 824, + "id": 826, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 524, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L524" } ], "type": { @@ -24461,15 +30950,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [826, 825, 824] + "children": [828, 827, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 522, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L522" } ] } @@ -24489,9 +30978,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -24506,7 +30995,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2698, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2698" } ], "signatures": [ @@ -24517,8 +31007,26 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.", - "text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "summary": [ + { + "kind": "text", + "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClientOptions#autoRefreshToken" + }, + { + "kind": "text", + "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "#stopAutoRefresh" + } + ] }, "type": { "type": "reference", @@ -24528,9 +31036,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -24545,7 +31053,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2711, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2711" } ], "signatures": [ @@ -24556,8 +31065,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).", - "text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n" + "summary": [ + { + "kind": "text", + "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#startAutoRefresh", + "target": 0 + }, + { + "kind": "text", + "text": " for more details." + } + ] }, "type": { "type": "reference", @@ -24567,9 +31090,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -24584,7 +31107,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2217, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2217" } ], "signatures": [ @@ -24595,7 +31119,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + "summary": [ + { + "kind": "text", + "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + } + ] }, "parameters": [ { @@ -24627,7 +31156,8 @@ { "fileName": "src/lib/types.ts", "line": 300, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L300" } ], "type": { @@ -24645,7 +31175,8 @@ { "fileName": "src/lib/types.ts", "line": 293, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L293" } ], "type": { @@ -24665,7 +31196,8 @@ { "fileName": "src/lib/types.ts", "line": 295, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" } ], "type": { @@ -24676,6 +31208,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" + } + ], "indexSignature": { "id": 733, "name": "__index", @@ -24712,7 +31252,8 @@ { "fileName": "src/lib/types.ts", "line": 298, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L298" } ], "type": { @@ -24732,7 +31273,8 @@ { "fileName": "src/lib/types.ts", "line": 301, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L301" } ], "type": { @@ -24750,7 +31292,8 @@ { "fileName": "src/lib/types.ts", "line": 299, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L299" } ], "type": { @@ -24770,7 +31313,8 @@ { "fileName": "src/lib/types.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L302" } ], "type": { @@ -24788,7 +31332,8 @@ { "fileName": "src/lib/types.ts", "line": 294, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L294" } ], "type": { @@ -24800,7 +31345,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [737, 729, 731, 735, 738, 736, 739, 730] } ], @@ -24808,7 +31352,8 @@ { "fileName": "src/lib/types.ts", "line": 292, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L292" } ] } @@ -24840,7 +31385,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2219, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2219" } ], "type": { @@ -24864,7 +31410,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2220, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2220" } ], "type": { @@ -24876,9 +31423,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [421, 423] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2218, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2218" + } ] } }, @@ -24901,7 +31455,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { @@ -24919,12 +31474,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -24932,18 +31488,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [425, 426] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2222, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -24958,7 +31521,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1660, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1660" } ], "signatures": [ @@ -24969,7 +31533,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates user data for a logged in user." + "summary": [ + { + "kind": "text", + "text": "Updates user data for a logged in user." + } + ] }, "parameters": [ { @@ -24998,14 +31567,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 397, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L397" } ], "type": { @@ -25022,13 +31612,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -25045,14 +31641,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -25069,13 +31670,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -25092,13 +31699,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -25110,7 +31723,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [786, 782, 785, 784, 783] } ], @@ -25118,7 +31730,8 @@ { "fileName": "src/lib/types.ts", "line": 368, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L368" } ] } @@ -25151,7 +31764,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1663, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1663" } ], "type": { @@ -25163,9 +31777,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [306] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1662, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1662" + } ] } }, @@ -25181,9 +31802,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -25198,7 +31819,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1172, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1172" } ], "signatures": [ @@ -25209,7 +31831,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + "summary": [ + { + "kind": "text", + "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + } + ] }, "parameters": [ { @@ -25220,10 +31847,10 @@ "flags": {}, "type": { "type": "reference", - "id": 933, + "id": 938, "name": "VerifyOtpParams", "dereferenced": { - "id": 933, + "id": 938, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -25232,21 +31859,22 @@ { "fileName": "src/lib/types.ts", "line": 719, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L719" } ], "type": { "type": "union", "types": [ { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -25257,20 +31885,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -25278,11 +31907,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "\n" + "tag": "@deprecated", + "content": [] } ] }, @@ -25290,7 +31924,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -25299,7 +31934,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -25307,13 +31942,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -25325,27 +31966,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -25354,19 +32008,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -25375,27 +32035,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25404,7 +32070,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -25427,39 +32094,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -25468,7 +32141,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -25479,20 +32152,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -25500,11 +32174,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -25512,7 +32191,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -25521,7 +32201,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -25529,13 +32209,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -25547,27 +32233,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -25576,27 +32275,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25605,7 +32310,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -25644,39 +32350,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -25685,27 +32397,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -25714,7 +32432,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -25753,15 +32472,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] } @@ -25780,9 +32499,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -25791,17 +32510,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [80] }, { "title": "Properties", - "kind": 1024, "children": [84, 85] }, { "title": "Methods", - "kind": 2048, "children": [ 157, 523, 232, 295, 404, 141, 414, 376, 225, 325, 229, 390, 313, 145, 213, 154, 216, 151, 222, 160, 366, 148, 472, 474, 417, 301, 219 @@ -25812,7 +32528,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 158, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L158" } ] }, @@ -25829,6 +32546,14 @@ "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 26, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L26" + } + ], "signatures": [ { "id": 558, @@ -25878,7 +32603,8 @@ { "fileName": "src/lib/locks.ts", "line": 24, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L24" } ], "type": { @@ -25895,12 +32621,10 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [557] }, { "title": "Properties", - "kind": 1024, "children": [560] } ], @@ -25908,7 +32632,8 @@ { "fileName": "src/lib/locks.ts", "line": 31, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L31" } ], "extendedTypes": [ @@ -25925,12 +32650,27 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "An authentication methord reference (AMR) entry.", - "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" + "kind": "text", + "text": "An authentication methord reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "." + } + ] } ] }, @@ -25942,13 +32682,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Authentication method name." + "summary": [ + { + "kind": "text", + "text": "Authentication method name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 283, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L283" } ], "type": { @@ -25999,13 +32745,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + "summary": [ + { + "kind": "text", + "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 289, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L289" } ], "type": { @@ -26017,7 +32769,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [725, 727] } ], @@ -26025,7 +32776,8 @@ { "fileName": "src/lib/types.ts", "line": 281, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L281" } ] }, @@ -26045,14 +32797,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -26069,14 +32842,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -26093,13 +32871,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -26120,14 +32904,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -26144,14 +32933,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -26168,14 +32978,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -26196,13 +33011,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -26223,14 +33044,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -26247,13 +33081,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -26274,14 +33114,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -26298,14 +33143,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -26322,14 +33204,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -26341,7 +33244,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788] } ], @@ -26349,7 +33251,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -26366,9 +33269,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] }, @@ -26379,19 +33282,58 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "A MFA factor.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#listFactors}" - }, + "kind": "text", + "text": "A MFA factor." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAAdminApi#listFactors}\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "listFactors", + "target": 1128 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueMFAAdminApi#listFactors" + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -26406,7 +33348,8 @@ { "fileName": "src/lib/types.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L327" } ], "type": { @@ -26421,13 +33364,35 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of factor. `totp` and `phone` supported with this version" + "summary": [ + { + "kind": "text", + "text": "Type of factor. " + }, + { + "kind": "code", + "text": "`totp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`phone`" + }, + { + "kind": "text", + "text": " supported with this version" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L322" } ], "type": { @@ -26472,13 +33437,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful to disambiguate between multiple factors." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L317" } ], "type": { @@ -26493,13 +33464,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor." + "summary": [ + { + "kind": "text", + "text": "ID of the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 314, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L314" } ], "type": { @@ -26514,13 +33491,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor's status." + "summary": [ + { + "kind": "text", + "text": "Factor's status." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 325, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L325" } ], "type": { @@ -26547,7 +33530,8 @@ { "fileName": "src/lib/types.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L328" } ], "type": { @@ -26559,7 +33543,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [746, 743, 742, 741, 745, 747] } ], @@ -26567,19 +33550,20 @@ { "fileName": "src/lib/types.ts", "line": 312, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L312" } ] }, { - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1005, + "id": 1010, "name": "data", "kind": 1024, "kindString": "Property", @@ -26587,14 +33571,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 851, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L851" } ], "type": { @@ -26603,7 +33608,7 @@ } }, { - "id": 1006, + "id": 1011, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -26611,13 +33616,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link generated." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link generated." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 853, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L853" } ], "type": { @@ -26629,82 +33640,108 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1005, 1006] + "children": [1010, 1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 845, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L845" } ] }, { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -26712,32 +33749,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -26746,19 +33790,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -26770,15 +33820,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } @@ -26792,55 +33842,69 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -26848,32 +33912,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -26885,15 +33956,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } @@ -26907,13 +33978,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -26922,57 +33993,75 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] }, { - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication API." + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication API." + } + ] }, "children": [ { - "id": 1111, + "id": 1116, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1058, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1058" + } + ], "signatures": [ { - "id": 1112, + "id": 1117, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + "summary": [ + { + "kind": "text", + "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + } + ] }, "parameters": [ { - "id": 1113, + "id": 1118, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "dereferenced": { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -26981,20 +34070,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -27002,13 +34092,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -27026,19 +34122,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -27050,15 +34152,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } @@ -27072,46 +34174,59 @@ "typeArguments": [ { "type": "reference", - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1120, + "id": 1125, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1076, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1076" + } + ], "signatures": [ { - "id": 1121, + "id": 1126, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1122, + "id": 1127, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -27120,32 +34235,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -27154,19 +34276,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -27178,15 +34306,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } @@ -27200,47 +34328,87 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1104, + "id": 1109, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1050, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1050" + }, + { + "fileName": "src/lib/types.ts", + "line": 1051, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1051" + }, + { + "fileName": "src/lib/types.ts", + "line": 1052, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1052" + } + ], "signatures": [ { - "id": 1105, + "id": 1110, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + "summary": [ + { + "kind": "text", + "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " + }, + { + "kind": "code", + "text": "`unverified`" + }, + { + "kind": "text", + "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 1106, + "id": 1111, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -27249,32 +34417,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -27283,7 +34458,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -27291,13 +34466,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -27306,7 +34487,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -27314,13 +34495,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -27332,15 +34519,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } @@ -27354,34 +34541,34 @@ "typeArguments": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1107, + "id": 1112, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1108, + "id": 1113, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -27390,32 +34577,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -27424,7 +34618,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -27432,13 +34626,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -27447,19 +34647,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -27471,15 +34677,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -27493,34 +34699,34 @@ "typeArguments": [ { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1109, + "id": 1114, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1115, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "dereferenced": { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -27529,14 +34735,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -27545,32 +34752,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -27579,7 +34793,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -27587,13 +34801,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -27602,7 +34822,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -27610,13 +34830,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -27628,22 +34854,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -27652,32 +34878,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -27686,7 +34919,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -27694,13 +34927,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -27709,19 +34948,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -27733,15 +34978,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -27758,77 +35003,161 @@ "typeArguments": [ { "type": "reference", - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1125, + "id": 1130, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1101, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1101" + } + ], "signatures": [ { - "id": 1126, + "id": 1131, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + "summary": [ + { + "kind": "text", + "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " + }, + { + "kind": "code", + "text": "`aal1`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1123, + "id": 1128, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1086, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1086" + } + ], "signatures": [ { - "id": 1124, + "id": 1129, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, + "kind": "text", + "text": "Returns the list of MFA factors enabled for this user." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getUser", + "target": 295 + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -27837,46 +35166,75 @@ "typeArguments": [ { "type": "reference", - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1117, + "id": 1122, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1070, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1070" + } + ], "signatures": [ { - "id": 1118, + "id": 1123, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + "summary": [ + { + "kind": "text", + "text": "Unenroll removes a MFA factor.\nA user has to have an " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " authenticator level in order to unenroll a " + }, + { + "kind": "code", + "text": "`verified`" + }, + { + "kind": "text", + "text": " factor." + } + ] }, "parameters": [ { - "id": 1119, + "id": 1124, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "dereferenced": { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -27885,32 +35243,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -27922,15 +35287,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } @@ -27944,46 +35309,59 @@ "typeArguments": [ { "type": "reference", - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1114, + "id": 1119, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1064, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1064" + } + ], "signatures": [ { - "id": 1115, + "id": 1120, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1116, + "id": 1121, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "dereferenced": { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -27992,32 +35370,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -28026,19 +35411,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -28047,19 +35438,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -28071,15 +35468,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } @@ -28093,13 +35490,13 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -28108,27 +35505,27 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1111, 1120, 1104, 1125, 1123, 1117, 1114] + "children": [1116, 1125, 1109, 1130, 1128, 1122, 1119] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1039" } ] }, { - "id": 1243, + "id": 1248, "name": "JWK", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1246, + "id": 1251, "name": "alg", "kind": 1024, "kindString": "Property", @@ -28139,7 +35536,8 @@ { "fileName": "src/lib/types.ts", "line": 1332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1332" } ], "type": { @@ -28148,7 +35546,7 @@ } }, { - "id": 1245, + "id": 1250, "name": "key_ops", "kind": 1024, "kindString": "Property", @@ -28157,7 +35555,8 @@ { "fileName": "src/lib/types.ts", "line": 1331, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1331" } ], "type": { @@ -28169,7 +35568,7 @@ } }, { - "id": 1247, + "id": 1252, "name": "kid", "kind": 1024, "kindString": "Property", @@ -28180,7 +35579,8 @@ { "fileName": "src/lib/types.ts", "line": 1333, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1333" } ], "type": { @@ -28189,7 +35589,7 @@ } }, { - "id": 1244, + "id": 1249, "name": "kty", "kind": 1024, "kindString": "Property", @@ -28198,7 +35598,8 @@ { "fileName": "src/lib/types.ts", "line": 1330, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1330" } ], "type": { @@ -28223,26 +35624,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1246, 1245, 1247, 1244] + "children": [1251, 1250, 1252, 1249] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1329, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1329" } ], "indexSignature": { - "id": 1248, + "id": 1253, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1249, + "id": 1254, "name": "key", "kind": 32768, "flags": {}, @@ -28272,13 +35673,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + "summary": [ + { + "kind": "text", + "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 252, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L252" } ], "type": { @@ -28295,13 +35702,19 @@ "isOptional": true }, "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "A timestamp of when the token will expire. Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 264, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L264" } ], "type": { @@ -28316,13 +35729,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 260, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L260" } ], "type": { @@ -28339,13 +35758,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + "summary": [ + { + "kind": "text", + "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L248" } ], "type": { @@ -28371,13 +35796,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + "summary": [ + { + "kind": "text", + "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 243, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L243" } ], "type": { @@ -28401,13 +35832,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "A one-time used refresh token that never expires." + "summary": [ + { + "kind": "text", + "text": "A one-time used refresh token that never expires." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 256, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L256" } ], "type": { @@ -28425,7 +35862,8 @@ { "fileName": "src/lib/types.ts", "line": 265, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L265" } ], "type": { @@ -28440,13 +35878,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + "summary": [ + { + "kind": "text", + "text": "When using a separate user storage, accessing properties of this object will throw an error." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 270, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L270" } ], "type": { @@ -28472,7 +35916,8 @@ { "fileName": "src/lib/types.ts", "line": 351, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L351" } ], "type": { @@ -28490,7 +35935,8 @@ { "fileName": "src/lib/types.ts", "line": 342, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L342" } ], "type": { @@ -28516,7 +35962,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -28528,7 +35975,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -28536,7 +35982,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -28575,7 +36022,8 @@ { "fileName": "src/lib/types.ts", "line": 344, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L344" } ], "type": { @@ -28595,7 +36043,8 @@ { "fileName": "src/lib/types.ts", "line": 345, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L345" } ], "type": { @@ -28615,7 +36064,8 @@ { "fileName": "src/lib/types.ts", "line": 355, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L355" } ], "type": { @@ -28633,7 +36083,8 @@ { "fileName": "src/lib/types.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L354" } ], "type": { @@ -28653,7 +36104,8 @@ { "fileName": "src/lib/types.ts", "line": 365, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L365" } ], "type": { @@ -28673,7 +36125,8 @@ { "fileName": "src/lib/types.ts", "line": 352, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L352" } ], "type": { @@ -28693,7 +36146,8 @@ { "fileName": "src/lib/types.ts", "line": 347, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L347" } ], "type": { @@ -28713,7 +36167,8 @@ { "fileName": "src/lib/types.ts", "line": 356, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L356" } ], "type": { @@ -28733,7 +36188,8 @@ { "fileName": "src/lib/types.ts", "line": 364, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L364" } ], "type": { @@ -28755,7 +36211,8 @@ { "fileName": "src/lib/types.ts", "line": 341, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L341" } ], "type": { @@ -28775,7 +36232,8 @@ { "fileName": "src/lib/types.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L361" } ], "type": { @@ -28799,7 +36257,8 @@ { "fileName": "src/lib/types.ts", "line": 350, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L350" } ], "type": { @@ -28819,7 +36278,8 @@ { "fileName": "src/lib/types.ts", "line": 362, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L362" } ], "type": { @@ -28839,7 +36299,8 @@ { "fileName": "src/lib/types.ts", "line": 363, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L363" } ], "type": { @@ -28859,7 +36320,8 @@ { "fileName": "src/lib/types.ts", "line": 358, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L358" } ], "type": { @@ -28879,7 +36341,8 @@ { "fileName": "src/lib/types.ts", "line": 348, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L348" } ], "type": { @@ -28899,7 +36362,8 @@ { "fileName": "src/lib/types.ts", "line": 349, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L349" } ], "type": { @@ -28919,7 +36383,8 @@ { "fileName": "src/lib/types.ts", "line": 353, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L353" } ], "type": { @@ -28939,7 +36404,8 @@ { "fileName": "src/lib/types.ts", "line": 357, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L357" } ], "type": { @@ -28959,7 +36425,8 @@ { "fileName": "src/lib/types.ts", "line": 346, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L346" } ], "type": { @@ -28979,7 +36446,8 @@ { "fileName": "src/lib/types.ts", "line": 359, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L359" } ], "type": { @@ -28999,7 +36467,8 @@ { "fileName": "src/lib/types.ts", "line": 360, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L360" } ], "type": { @@ -29017,7 +36486,8 @@ { "fileName": "src/lib/types.ts", "line": 343, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L343" } ], "type": { @@ -29034,7 +36504,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -29067,7 +36538,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 766, 757, 759, 760, 770, 769, 780, 767, 762, 771, 779, 756, 776, 765, 777, 778, 773, 763, 764, 768, 772, 761, 774, 775, 758 @@ -29078,7 +36548,8 @@ { "fileName": "src/lib/types.ts", "line": 340, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L340" } ] } @@ -29088,7 +36559,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [718, 721, 720, 717, 716, 719, 722, 723] } ], @@ -29096,7 +36566,8 @@ { "fileName": "src/lib/types.ts", "line": 239, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L239" } ] }, @@ -29107,201 +36578,189 @@ "kindString": "Interface", "flags": {}, "children": [ - { - "id": 801, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 802, "name": "callback", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 483, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 803, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 483, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" + } + ], + "signatures": [ { "id": 804, - "name": "event", - "kind": 32768, - "kindString": "Parameter", + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "type": { - "type": "reference", - "id": 574, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 574, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to call every time there is an event. eg: (eventName) => {}" + } + ] + }, + "parameters": [ + { + "id": 805, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 574, + "name": "AuthChangeEvent" + } + }, + { + "id": 806, + "name": "session", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], "type": { "type": "union", "types": [ { "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" + "value": null }, { - "id": 573, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } + "type": "reference", + "id": 715, + "name": "Session" } ] } } - } - }, - { - "id": 805, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, + ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 715, - "name": "Session" - } - ] + "type": "intrinsic", + "name": "void" } } - ], - "type": { - "type": "intrinsic", - "name": "void" + ] + } + } + }, + { + "id": 801, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subscriber UUID. This will be set by the client." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L479" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 806, + "id": 807, "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 487, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" } ], - "signatures": [ - { - "id": 807, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" + } + ], + "signatures": [ + { + "id": 809, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Call this to remove the listener." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [801] - }, - { - "title": "Methods", - "kind": 2048, - "children": [802, 806] + "children": [802, 801, 807] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 475, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L475" } ] }, @@ -29324,7 +36783,8 @@ { "fileName": "src/lib/types.ts", "line": 351, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L351" } ], "type": { @@ -29342,7 +36802,8 @@ { "fileName": "src/lib/types.ts", "line": 342, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L342" } ], "type": { @@ -29368,7 +36829,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -29380,7 +36842,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -29388,7 +36849,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -29427,7 +36889,8 @@ { "fileName": "src/lib/types.ts", "line": 344, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L344" } ], "type": { @@ -29447,7 +36910,8 @@ { "fileName": "src/lib/types.ts", "line": 345, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L345" } ], "type": { @@ -29467,7 +36931,8 @@ { "fileName": "src/lib/types.ts", "line": 355, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L355" } ], "type": { @@ -29485,7 +36950,8 @@ { "fileName": "src/lib/types.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L354" } ], "type": { @@ -29505,7 +36971,8 @@ { "fileName": "src/lib/types.ts", "line": 365, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L365" } ], "type": { @@ -29525,7 +36992,8 @@ { "fileName": "src/lib/types.ts", "line": 352, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L352" } ], "type": { @@ -29545,7 +37013,8 @@ { "fileName": "src/lib/types.ts", "line": 347, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L347" } ], "type": { @@ -29565,7 +37034,8 @@ { "fileName": "src/lib/types.ts", "line": 356, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L356" } ], "type": { @@ -29585,7 +37055,8 @@ { "fileName": "src/lib/types.ts", "line": 364, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L364" } ], "type": { @@ -29607,7 +37078,8 @@ { "fileName": "src/lib/types.ts", "line": 341, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L341" } ], "type": { @@ -29627,7 +37099,8 @@ { "fileName": "src/lib/types.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L361" } ], "type": { @@ -29651,7 +37124,8 @@ { "fileName": "src/lib/types.ts", "line": 350, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L350" } ], "type": { @@ -29671,7 +37145,8 @@ { "fileName": "src/lib/types.ts", "line": 362, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L362" } ], "type": { @@ -29691,7 +37166,8 @@ { "fileName": "src/lib/types.ts", "line": 363, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L363" } ], "type": { @@ -29711,7 +37187,8 @@ { "fileName": "src/lib/types.ts", "line": 358, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L358" } ], "type": { @@ -29731,7 +37208,8 @@ { "fileName": "src/lib/types.ts", "line": 348, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L348" } ], "type": { @@ -29751,7 +37229,8 @@ { "fileName": "src/lib/types.ts", "line": 349, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L349" } ], "type": { @@ -29771,7 +37250,8 @@ { "fileName": "src/lib/types.ts", "line": 353, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L353" } ], "type": { @@ -29791,7 +37271,8 @@ { "fileName": "src/lib/types.ts", "line": 357, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L357" } ], "type": { @@ -29811,7 +37292,8 @@ { "fileName": "src/lib/types.ts", "line": 346, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L346" } ], "type": { @@ -29831,7 +37313,8 @@ { "fileName": "src/lib/types.ts", "line": 359, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L359" } ], "type": { @@ -29851,7 +37334,8 @@ { "fileName": "src/lib/types.ts", "line": 360, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L360" } ], "type": { @@ -29869,7 +37353,8 @@ { "fileName": "src/lib/types.ts", "line": 343, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L343" } ], "type": { @@ -29886,7 +37371,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -29919,7 +37405,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 766, 757, 759, 760, 770, 769, 780, 767, 762, 771, 779, 756, 776, 765, 777, 778, 773, 763, 764, 768, 772, 761, 774, 775, 758 @@ -29930,7 +37415,8 @@ { "fileName": "src/lib/types.ts", "line": 340, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L340" } ] }, @@ -29953,7 +37439,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -29965,7 +37452,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -29973,7 +37459,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -30016,14 +37503,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 397, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L397" } ], "type": { @@ -30040,13 +37548,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -30063,14 +37577,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -30087,13 +37606,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -30110,13 +37635,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -30128,7 +37659,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [786, 782, 785, 784, 783] } ], @@ -30136,7 +37666,8 @@ { "fileName": "src/lib/types.ts", "line": 368, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L368" } ] }, @@ -30159,7 +37690,8 @@ { "fileName": "src/lib/types.ts", "line": 300, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L300" } ], "type": { @@ -30177,7 +37709,8 @@ { "fileName": "src/lib/types.ts", "line": 293, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L293" } ], "type": { @@ -30197,7 +37730,8 @@ { "fileName": "src/lib/types.ts", "line": 295, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" } ], "type": { @@ -30208,6 +37742,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" + } + ], "indexSignature": { "id": 733, "name": "__index", @@ -30244,7 +37786,8 @@ { "fileName": "src/lib/types.ts", "line": 298, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L298" } ], "type": { @@ -30264,7 +37807,8 @@ { "fileName": "src/lib/types.ts", "line": 301, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L301" } ], "type": { @@ -30282,7 +37826,8 @@ { "fileName": "src/lib/types.ts", "line": 299, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L299" } ], "type": { @@ -30302,7 +37847,8 @@ { "fileName": "src/lib/types.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L302" } ], "type": { @@ -30320,7 +37866,8 @@ { "fileName": "src/lib/types.ts", "line": 294, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L294" } ], "type": { @@ -30332,7 +37879,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [737, 729, 731, 735, 738, 736, 739, 730] } ], @@ -30340,7 +37886,8 @@ { "fileName": "src/lib/types.ts", "line": 292, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L292" } ] }, @@ -30354,7 +37901,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -30382,26 +37930,32 @@ } }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -30410,7 +37964,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -30421,20 +37975,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30442,11 +37997,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -30454,7 +38014,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -30463,7 +38024,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -30471,13 +38032,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -30489,27 +38056,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -30518,27 +38098,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -30547,7 +38133,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -30586,27 +38173,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -30617,20 +38204,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30638,11 +38226,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -30650,7 +38243,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -30659,7 +38253,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -30667,13 +38261,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -30685,27 +38285,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -30714,19 +38327,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -30735,27 +38354,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -30764,7 +38389,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -30787,39 +38413,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -30828,27 +38460,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -30857,7 +38495,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -30896,15 +38535,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] }, @@ -30918,7 +38557,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L34" } ], "type": { @@ -30958,7 +38598,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L32" } ], "type": { @@ -30979,7 +38620,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L32" } ], "type": { @@ -30988,7 +38630,7 @@ } }, { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -30997,7 +38639,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -31015,16 +38658,17 @@ } }, { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -31032,32 +38676,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -31066,19 +38717,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -31090,31 +38747,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } } }, { - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -31122,7 +38780,8 @@ { "fileName": "src/lib/types.ts", "line": 1107, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1107" } ], "type": { @@ -31131,14 +38790,14 @@ { "type": "reflection", "declaration": { - "id": 1128, + "id": 1133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1129, + "id": 1134, "name": "data", "kind": 1024, "kindString": "Property", @@ -31147,32 +38806,39 @@ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ], "type": { "type": "reflection", "declaration": { - "id": 1130, + "id": 1135, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1131, + "id": 1136, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1111" } ], "type": { @@ -31184,22 +38850,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1131] + "children": [1136] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ] } } }, { - "id": 1132, + "id": 1137, "name": "error", "kind": 1024, "kindString": "Property", @@ -31208,7 +38874,8 @@ { "fileName": "src/lib/types.ts", "line": 1113, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1113" } ], "type": { @@ -31220,15 +38887,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1129, 1132] + "children": [1134, 1137] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1108, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1108" } ] } @@ -31236,14 +38903,14 @@ { "type": "reflection", "declaration": { - "id": 1133, + "id": 1138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1134, + "id": 1139, "name": "data", "kind": 1024, "kindString": "Property", @@ -31252,7 +38919,8 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { @@ -31261,7 +38929,7 @@ } }, { - "id": 1135, + "id": 1140, "name": "error", "kind": 1024, "kindString": "Property", @@ -31270,12 +38938,13 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -31283,15 +38952,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1134, 1135] + "children": [1139, 1140] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ] } @@ -31300,16 +38969,17 @@ } }, { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -31317,32 +38987,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -31354,31 +39031,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } } }, { - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -31386,7 +39064,8 @@ { "fileName": "src/lib/types.ts", "line": 1131, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1131" } ], "type": { @@ -31395,14 +39074,14 @@ { "type": "reflection", "declaration": { - "id": 1141, + "id": 1146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1142, + "id": 1147, "name": "data", "kind": 1024, "kindString": "Property", @@ -31411,32 +39090,39 @@ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ], "type": { "type": "reflection", "declaration": { - "id": 1143, + "id": 1148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1144, + "id": 1149, "name": "factors", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All factors attached to the user." + "summary": [ + { + "kind": "text", + "text": "All factors attached to the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1135" } ], "type": { @@ -31452,22 +39138,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1144] + "children": [1149] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ] } } }, { - "id": 1145, + "id": 1150, "name": "error", "kind": 1024, "kindString": "Property", @@ -31476,7 +39162,8 @@ { "fileName": "src/lib/types.ts", "line": 1137, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1137" } ], "type": { @@ -31488,15 +39175,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1142, 1145] + "children": [1147, 1150] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1132, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1132" } ] } @@ -31504,14 +39191,14 @@ { "type": "reflection", "declaration": { - "id": 1146, + "id": 1151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1147, + "id": 1152, "name": "data", "kind": 1024, "kindString": "Property", @@ -31520,7 +39207,8 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { @@ -31529,7 +39217,7 @@ } }, { - "id": 1148, + "id": 1153, "name": "error", "kind": 1024, "kindString": "Property", @@ -31538,12 +39226,13 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -31551,15 +39240,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1147, 1148] + "children": [1152, 1153] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ] } @@ -31568,7 +39257,7 @@ } }, { - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -31577,7 +39266,8 @@ { "fileName": "src/lib/types.ts", "line": 977, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L977" } ], "type": { @@ -31586,14 +39276,14 @@ { "type": "reflection", "declaration": { - "id": 1070, + "id": 1075, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1071, + "id": 1076, "name": "data", "kind": 1024, "kindString": "Property", @@ -31602,32 +39292,39 @@ { "fileName": "src/lib/types.ts", "line": 979, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ], "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1075, + "id": 1080, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." + "summary": [ + { + "kind": "text", + "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 987, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L987" } ], "type": { @@ -31636,19 +39333,25 @@ } }, { - "id": 1073, + "id": 1078, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the newly created challenge." + "summary": [ + { + "kind": "text", + "text": "ID of the newly created challenge." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 981, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L981" } ], "type": { @@ -31657,19 +39360,25 @@ } }, { - "id": 1074, + "id": 1079, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor Type which generated the challenge" + "summary": [ + { + "kind": "text", + "text": "Factor Type which generated the challenge" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 984, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L984" } ], "type": { @@ -31690,22 +39399,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1075, 1073, 1074] + "children": [1080, 1078, 1079] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 979, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ] } } }, { - "id": 1076, + "id": 1081, "name": "error", "kind": 1024, "kindString": "Property", @@ -31714,7 +39423,8 @@ { "fileName": "src/lib/types.ts", "line": 989, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L989" } ], "type": { @@ -31726,15 +39436,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1071, 1076] + "children": [1076, 1081] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 978, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L978" } ] } @@ -31742,14 +39452,14 @@ { "type": "reflection", "declaration": { - "id": 1077, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1078, + "id": 1083, "name": "data", "kind": 1024, "kindString": "Property", @@ -31758,7 +39468,8 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { @@ -31767,7 +39478,7 @@ } }, { - "id": 1079, + "id": 1084, "name": "error", "kind": 1024, "kindString": "Property", @@ -31776,12 +39487,13 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -31789,15 +39501,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1078, 1079] + "children": [1083, 1084] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 991, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ] } @@ -31806,7 +39518,7 @@ } }, { - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -31815,7 +39527,8 @@ { "fileName": "src/lib/types.ts", "line": 1286, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1286" } ], "type": { @@ -31824,14 +39537,14 @@ { "type": "reflection", "declaration": { - "id": 1213, + "id": 1218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1214, + "id": 1219, "name": "data", "kind": 1024, "kindString": "Property", @@ -31840,20 +39553,21 @@ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ], "type": { "type": "reflection", "declaration": { - "id": 1215, + "id": 1220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1218, + "id": 1223, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -31861,13 +39575,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1296, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1296" } ], "type": { @@ -31876,19 +39596,25 @@ } }, { - "id": 1216, + "id": 1221, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1290, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1290" } ], "type": { @@ -31897,19 +39623,25 @@ } }, { - "id": 1219, + "id": 1224, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + "summary": [ + { + "kind": "text", + "text": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1299, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1299" } ], "type": { @@ -31918,19 +39650,25 @@ } }, { - "id": 1217, + "id": 1222, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1293, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1293" } ], "type": { @@ -31942,22 +39680,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1218, 1216, 1219, 1217] + "children": [1223, 1221, 1224, 1222] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ] } } }, { - "id": 1220, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -31966,7 +39704,8 @@ { "fileName": "src/lib/types.ts", "line": 1301, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1301" } ], "type": { @@ -31978,15 +39717,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1214, 1220] + "children": [1219, 1225] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1287" } ] } @@ -31994,14 +39733,14 @@ { "type": "reflection", "declaration": { - "id": 1221, + "id": 1226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1222, + "id": 1227, "name": "data", "kind": 1024, "kindString": "Property", @@ -32010,7 +39749,8 @@ { "fileName": "src/lib/types.ts", "line": 1304, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1304" } ], "type": { @@ -32019,7 +39759,7 @@ } }, { - "id": 1223, + "id": 1228, "name": "error", "kind": 1024, "kindString": "Property", @@ -32028,12 +39768,13 @@ { "fileName": "src/lib/types.ts", "line": 1305, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1305" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -32041,15 +39782,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1222, 1223] + "children": [1227, 1228] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1303, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1303" } ] } @@ -32058,7 +39799,7 @@ } }, { - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -32067,14 +39808,15 @@ { "fileName": "src/lib/types.ts", "line": 965, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L965" } ], "type": { "type": "union", "types": [ { - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -32083,7 +39825,8 @@ { "fileName": "src/lib/types.ts", "line": 1251, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1251" } ], "type": { @@ -32092,14 +39835,14 @@ { "type": "reflection", "declaration": { - "id": 1197, + "id": 1202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1198, + "id": 1203, "name": "data", "kind": 1024, "kindString": "Property", @@ -32108,20 +39851,21 @@ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ], "type": { "type": "reflection", "declaration": { - "id": 1199, + "id": 1204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1207, + "id": 1212, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -32129,13 +39873,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1277, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1277" } ], "type": { @@ -32144,19 +39894,25 @@ } }, { - "id": 1200, + "id": 1205, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1255, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1255" } ], "type": { @@ -32165,44 +39921,64 @@ } }, { - "id": 1202, + "id": 1207, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "TOTP enrollment information." + "summary": [ + { + "kind": "text", + "text": "TOTP enrollment information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ], "type": { "type": "reflection", "declaration": { - "id": 1203, + "id": 1208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1204, + "id": 1209, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending " + }, + { + "kind": "code", + "text": "`data:image/svg+xml;utf-8,`" + }, + { + "kind": "text", + "text": " to\nthe value. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1265, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1265" } ], "type": { @@ -32211,19 +39987,25 @@ } }, { - "id": 1205, + "id": 1210, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1270, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1270" } ], "type": { @@ -32232,19 +40014,25 @@ } }, { - "id": 1206, + "id": 1211, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + "summary": [ + { + "kind": "text", + "text": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1274, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1274" } ], "type": { @@ -32256,34 +40044,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1204, 1205, 1206] + "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ] } } }, { - "id": 1201, + "id": 1206, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1258, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1258" } ], "type": { @@ -32295,22 +40089,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1207, 1200, 1202, 1201] + "children": [1212, 1205, 1207, 1206] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ] } } }, { - "id": 1208, + "id": 1213, "name": "error", "kind": 1024, "kindString": "Property", @@ -32319,7 +40113,8 @@ { "fileName": "src/lib/types.ts", "line": 1279, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1279" } ], "type": { @@ -32331,15 +40126,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1198, 1208] + "children": [1203, 1213] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1252, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1252" } ] } @@ -32347,14 +40142,14 @@ { "type": "reflection", "declaration": { - "id": 1209, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1210, + "id": 1215, "name": "data", "kind": 1024, "kindString": "Property", @@ -32363,7 +40158,8 @@ { "fileName": "src/lib/types.ts", "line": 1282, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1282" } ], "type": { @@ -32372,7 +40168,7 @@ } }, { - "id": 1211, + "id": 1216, "name": "error", "kind": 1024, "kindString": "Property", @@ -32381,12 +40177,13 @@ { "fileName": "src/lib/types.ts", "line": 1283, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1283" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -32394,15 +40191,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1210, 1211] + "children": [1215, 1216] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1281, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1281" } ] } @@ -32411,7 +40208,7 @@ } }, { - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -32420,7 +40217,8 @@ { "fileName": "src/lib/types.ts", "line": 1286, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1286" } ], "type": { @@ -32429,14 +40227,14 @@ { "type": "reflection", "declaration": { - "id": 1213, + "id": 1218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1214, + "id": 1219, "name": "data", "kind": 1024, "kindString": "Property", @@ -32445,20 +40243,21 @@ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ], "type": { "type": "reflection", "declaration": { - "id": 1215, + "id": 1220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1218, + "id": 1223, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -32466,13 +40265,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1296, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1296" } ], "type": { @@ -32481,19 +40286,25 @@ } }, { - "id": 1216, + "id": 1221, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1290, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1290" } ], "type": { @@ -32502,19 +40313,25 @@ } }, { - "id": 1219, + "id": 1224, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + "summary": [ + { + "kind": "text", + "text": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1299, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1299" } ], "type": { @@ -32523,19 +40340,25 @@ } }, { - "id": 1217, + "id": 1222, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1293, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1293" } ], "type": { @@ -32547,22 +40370,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1218, 1216, 1219, 1217] + "children": [1223, 1221, 1224, 1222] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ] } } }, { - "id": 1220, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -32571,7 +40394,8 @@ { "fileName": "src/lib/types.ts", "line": 1301, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1301" } ], "type": { @@ -32583,15 +40407,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1214, 1220] + "children": [1219, 1225] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1287" } ] } @@ -32599,14 +40423,14 @@ { "type": "reflection", "declaration": { - "id": 1221, + "id": 1226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1222, + "id": 1227, "name": "data", "kind": 1024, "kindString": "Property", @@ -32615,7 +40439,8 @@ { "fileName": "src/lib/types.ts", "line": 1304, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1304" } ], "type": { @@ -32624,7 +40449,7 @@ } }, { - "id": 1223, + "id": 1228, "name": "error", "kind": 1024, "kindString": "Property", @@ -32633,12 +40458,13 @@ { "fileName": "src/lib/types.ts", "line": 1305, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1305" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -32646,15 +40472,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1222, 1223] + "children": [1227, 1228] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1303, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1303" } ] } @@ -32666,7 +40492,7 @@ } }, { - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -32675,7 +40501,8 @@ { "fileName": "src/lib/types.ts", "line": 1251, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1251" } ], "type": { @@ -32684,14 +40511,14 @@ { "type": "reflection", "declaration": { - "id": 1197, + "id": 1202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1198, + "id": 1203, "name": "data", "kind": 1024, "kindString": "Property", @@ -32700,20 +40527,21 @@ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ], "type": { "type": "reflection", "declaration": { - "id": 1199, + "id": 1204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1207, + "id": 1212, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -32721,13 +40549,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1277, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1277" } ], "type": { @@ -32736,19 +40570,25 @@ } }, { - "id": 1200, + "id": 1205, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1255, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1255" } ], "type": { @@ -32757,44 +40597,64 @@ } }, { - "id": 1202, + "id": 1207, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "TOTP enrollment information." + "summary": [ + { + "kind": "text", + "text": "TOTP enrollment information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ], "type": { "type": "reflection", "declaration": { - "id": 1203, + "id": 1208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1204, + "id": 1209, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending " + }, + { + "kind": "code", + "text": "`data:image/svg+xml;utf-8,`" + }, + { + "kind": "text", + "text": " to\nthe value. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1265, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1265" } ], "type": { @@ -32803,19 +40663,25 @@ } }, { - "id": 1205, + "id": 1210, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1270, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1270" } ], "type": { @@ -32824,19 +40690,25 @@ } }, { - "id": 1206, + "id": 1211, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + "summary": [ + { + "kind": "text", + "text": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1274, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1274" } ], "type": { @@ -32848,34 +40720,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1204, 1205, 1206] + "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ] } } }, { - "id": 1201, + "id": 1206, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1258, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1258" } ], "type": { @@ -32887,22 +40765,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1207, 1200, 1202, 1201] + "children": [1212, 1205, 1207, 1206] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ] } } }, { - "id": 1208, + "id": 1213, "name": "error", "kind": 1024, "kindString": "Property", @@ -32911,7 +40789,8 @@ { "fileName": "src/lib/types.ts", "line": 1279, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1279" } ], "type": { @@ -32923,15 +40802,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1198, 1208] + "children": [1203, 1213] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1252, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1252" } ] } @@ -32939,14 +40818,14 @@ { "type": "reflection", "declaration": { - "id": 1209, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1210, + "id": 1215, "name": "data", "kind": 1024, "kindString": "Property", @@ -32955,7 +40834,8 @@ { "fileName": "src/lib/types.ts", "line": 1282, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1282" } ], "type": { @@ -32964,7 +40844,7 @@ } }, { - "id": 1211, + "id": 1216, "name": "error", "kind": 1024, "kindString": "Property", @@ -32973,12 +40853,13 @@ { "fileName": "src/lib/types.ts", "line": 1283, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1283" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -32986,15 +40867,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1210, 1211] + "children": [1215, 1216] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1281, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1281" } ] } @@ -33003,7 +40884,7 @@ } }, { - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -33012,7 +40893,8 @@ { "fileName": "src/lib/types.ts", "line": 1010, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1010" } ], "type": { @@ -33021,14 +40903,14 @@ { "type": "reflection", "declaration": { - "id": 1093, + "id": 1098, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1094, + "id": 1099, "name": "data", "kind": 1024, "kindString": "Property", @@ -33037,32 +40919,39 @@ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ], "type": { "type": "reflection", "declaration": { - "id": 1095, + "id": 1100, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1098, + "id": 1103, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + "summary": [ + { + "kind": "text", + "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1029, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1029" } ], "type": { @@ -33075,19 +40964,25 @@ } }, { - "id": 1096, + "id": 1101, "name": "currentLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Current AAL level of the session." + "summary": [ + { + "kind": "text", + "text": "Current AAL level of the session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1014, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1014" } ], "type": { @@ -33095,7 +40990,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -33106,17 +41001,29 @@ } }, { - "id": 1097, + "id": 1102, "name": "nextLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "challenge", + "target": 1116 + } + ] } ] }, @@ -33124,7 +41031,8 @@ { "fileName": "src/lib/types.ts", "line": 1022, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1022" } ], "type": { @@ -33132,7 +41040,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -33146,22 +41054,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1098, 1096, 1097] + "children": [1103, 1101, 1102] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ] } } }, { - "id": 1099, + "id": 1104, "name": "error", "kind": 1024, "kindString": "Property", @@ -33170,7 +41078,8 @@ { "fileName": "src/lib/types.ts", "line": 1031, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1031" } ], "type": { @@ -33182,15 +41091,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1094, 1099] + "children": [1099, 1104] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1011, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1011" } ] } @@ -33198,14 +41107,14 @@ { "type": "reflection", "declaration": { - "id": 1100, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1101, + "id": 1106, "name": "data", "kind": 1024, "kindString": "Property", @@ -33214,7 +41123,8 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { @@ -33223,7 +41133,7 @@ } }, { - "id": 1102, + "id": 1107, "name": "error", "kind": 1024, "kindString": "Property", @@ -33232,12 +41142,13 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -33245,15 +41156,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1101, 1102] + "children": [1106, 1107] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ] } @@ -33262,7 +41173,7 @@ } }, { - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -33271,7 +41182,8 @@ { "fileName": "src/lib/types.ts", "line": 993, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L993" } ], "type": { @@ -33280,14 +41192,14 @@ { "type": "reflection", "declaration": { - "id": 1081, + "id": 1086, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1082, + "id": 1087, "name": "data", "kind": 1024, "kindString": "Property", @@ -33296,32 +41208,39 @@ { "fileName": "src/lib/types.ts", "line": 995, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ], "type": { "type": "reflection", "declaration": { - "id": 1083, + "id": 1088, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1084, + "id": 1089, "name": "all", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All available factors (verified and unverified)." + "summary": [ + { + "kind": "text", + "text": "All available factors (verified and unverified)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 997, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L997" } ], "type": { @@ -33334,19 +41253,33 @@ } }, { - "id": 1086, + "id": 1091, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified Phone factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified Phone factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1002, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1002" } ], "type": { @@ -33359,19 +41292,33 @@ } }, { - "id": 1085, + "id": 1090, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified TOTP factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1000, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1000" } ], "type": { @@ -33387,22 +41334,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1084, 1086, 1085] + "children": [1089, 1091, 1090] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 995, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ] } } }, { - "id": 1087, + "id": 1092, "name": "error", "kind": 1024, "kindString": "Property", @@ -33411,7 +41358,8 @@ { "fileName": "src/lib/types.ts", "line": 1004, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1004" } ], "type": { @@ -33423,15 +41371,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1082, 1087] + "children": [1087, 1092] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 994, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L994" } ] } @@ -33439,14 +41387,14 @@ { "type": "reflection", "declaration": { - "id": 1088, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1089, + "id": 1094, "name": "data", "kind": 1024, "kindString": "Property", @@ -33455,7 +41403,8 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { @@ -33464,7 +41413,7 @@ } }, { - "id": 1090, + "id": 1095, "name": "error", "kind": 1024, "kindString": "Property", @@ -33473,12 +41422,13 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -33486,15 +41436,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1089, 1090] + "children": [1094, 1095] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ] } @@ -33503,7 +41453,7 @@ } }, { - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -33512,7 +41462,8 @@ { "fileName": "src/lib/types.ts", "line": 967, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L967" } ], "type": { @@ -33521,14 +41472,14 @@ { "type": "reflection", "declaration": { - "id": 1061, + "id": 1066, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1067, "name": "data", "kind": 1024, "kindString": "Property", @@ -33537,32 +41488,39 @@ { "fileName": "src/lib/types.ts", "line": 969, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ], "type": { "type": "reflection", "declaration": { - "id": 1063, + "id": 1068, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1064, + "id": 1069, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 971, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L971" } ], "type": { @@ -33574,22 +41532,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1064] + "children": [1069] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 969, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ] } } }, { - "id": 1065, + "id": 1070, "name": "error", "kind": 1024, "kindString": "Property", @@ -33598,7 +41556,8 @@ { "fileName": "src/lib/types.ts", "line": 973, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L973" } ], "type": { @@ -33610,15 +41569,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1062, 1065] + "children": [1067, 1070] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 968, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L968" } ] } @@ -33626,14 +41585,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1071, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1072, "name": "data", "kind": 1024, "kindString": "Property", @@ -33642,7 +41601,8 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { @@ -33651,7 +41611,7 @@ } }, { - "id": 1068, + "id": 1073, "name": "error", "kind": 1024, "kindString": "Property", @@ -33660,12 +41620,13 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -33673,15 +41634,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1067, 1068] + "children": [1072, 1073] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 975, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ] } @@ -33690,7 +41651,7 @@ } }, { - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -33699,7 +41660,8 @@ { "fileName": "src/lib/types.ts", "line": 940, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L940" } ], "type": { @@ -33708,14 +41670,14 @@ { "type": "reflection", "declaration": { - "id": 1047, + "id": 1052, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1048, + "id": 1053, "name": "data", "kind": 1024, "kindString": "Property", @@ -33724,32 +41686,39 @@ { "fileName": "src/lib/types.ts", "line": 942, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ], "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1054, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1055, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "New access token (JWT) after successful verification." + "summary": [ + { + "kind": "text", + "text": "New access token (JWT) after successful verification." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 944, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L944" } ], "type": { @@ -33758,19 +41727,25 @@ } }, { - "id": 1052, + "id": 1057, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Number of seconds in which the access token will expire." + "summary": [ + { + "kind": "text", + "text": "Number of seconds in which the access token will expire." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 950, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L950" } ], "type": { @@ -33779,19 +41754,25 @@ } }, { - "id": 1053, + "id": 1058, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." + "summary": [ + { + "kind": "text", + "text": "Refresh token you can use to obtain new access tokens when expired." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 953, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L953" } ], "type": { @@ -33800,19 +41781,33 @@ } }, { - "id": 1051, + "id": 1056, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of token, typically `Bearer`." + "summary": [ + { + "kind": "text", + "text": "Type of token, typically " + }, + { + "kind": "code", + "text": "`Bearer`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 947, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L947" } ], "type": { @@ -33821,19 +41816,25 @@ } }, { - "id": 1054, + "id": 1059, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Updated user profile." + "summary": [ + { + "kind": "text", + "text": "Updated user profile." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 956, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L956" } ], "type": { @@ -33846,22 +41847,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1050, 1052, 1053, 1051, 1054] + "children": [1055, 1057, 1058, 1056, 1059] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 942, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ] } } }, { - "id": 1055, + "id": 1060, "name": "error", "kind": 1024, "kindString": "Property", @@ -33870,7 +41871,8 @@ { "fileName": "src/lib/types.ts", "line": 958, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L958" } ], "type": { @@ -33882,15 +41884,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1048, 1055] + "children": [1053, 1060] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 941, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L941" } ] } @@ -33898,14 +41900,14 @@ { "type": "reflection", "declaration": { - "id": 1056, + "id": 1061, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1062, "name": "data", "kind": 1024, "kindString": "Property", @@ -33914,7 +41916,8 @@ { "fileName": "src/lib/types.ts", "line": 961, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L961" } ], "type": { @@ -33923,7 +41926,7 @@ } }, { - "id": 1058, + "id": 1063, "name": "error", "kind": 1024, "kindString": "Property", @@ -33932,12 +41935,13 @@ { "fileName": "src/lib/types.ts", "line": 962, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L962" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -33945,15 +41949,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1057, 1058] + "children": [1062, 1063] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 960, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L960" } ] } @@ -33968,14 +41972,24 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthResponse}\n" + "summary": [ + { + "kind": "text", + "text": "AuthOtpResponse is returned when OTP is used.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "AuthResponse" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 146, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L146" } ], "type": { @@ -34000,7 +42014,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -34024,7 +42039,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -34051,7 +42067,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -34069,7 +42086,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -34081,7 +42099,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [645, 644, 643] } ], @@ -34089,7 +42106,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ] } @@ -34105,7 +42123,8 @@ { "fileName": "src/lib/types.ts", "line": 149, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L149" } ], "type": { @@ -34117,7 +42136,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [641, 646] } ], @@ -34125,7 +42143,8 @@ { "fileName": "src/lib/types.ts", "line": 147, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L147" } ] } @@ -34149,7 +42168,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -34173,7 +42193,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -34200,7 +42221,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -34218,7 +42240,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -34230,7 +42253,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [652, 651, 650] } ], @@ -34238,7 +42260,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ] } @@ -34254,12 +42277,13 @@ { "fileName": "src/lib/types.ts", "line": 153, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L153" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -34267,7 +42291,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [648, 653] } ], @@ -34275,7 +42298,8 @@ { "fileName": "src/lib/types.ts", "line": 151, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L151" } ] } @@ -34293,7 +42317,8 @@ { "fileName": "src/lib/types.ts", "line": 108, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L108" } ], "type": { @@ -34318,7 +42343,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ], "type": { @@ -34340,7 +42366,8 @@ { "fileName": "src/lib/types.ts", "line": 112, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L112" } ], "type": { @@ -34368,7 +42395,8 @@ { "fileName": "src/lib/types.ts", "line": 111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L111" } ], "type": { @@ -34390,7 +42418,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [617, 616] } ], @@ -34398,7 +42425,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ] } @@ -34414,7 +42442,8 @@ { "fileName": "src/lib/types.ts", "line": 114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L114" } ], "type": { @@ -34426,7 +42455,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [614, 618] } ], @@ -34434,7 +42462,8 @@ { "fileName": "src/lib/types.ts", "line": 109, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L109" } ] } @@ -34458,7 +42487,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ], "type": { @@ -34480,7 +42510,8 @@ { "fileName": "src/lib/types.ts", "line": 119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L119" } ], "type": { @@ -34498,7 +42529,8 @@ { "fileName": "src/lib/types.ts", "line": 118, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L118" } ], "type": { @@ -34510,7 +42542,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [623, 622] } ], @@ -34518,7 +42549,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ] } @@ -34534,12 +42566,13 @@ { "fileName": "src/lib/types.ts", "line": 121, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L121" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -34547,7 +42580,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [620, 624] } ], @@ -34555,7 +42587,8 @@ { "fileName": "src/lib/types.ts", "line": 116, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L116" } ] } @@ -34573,7 +42606,8 @@ { "fileName": "src/lib/types.ts", "line": 124, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L124" } ], "type": { @@ -34598,7 +42632,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ], "type": { @@ -34620,7 +42655,8 @@ { "fileName": "src/lib/types.ts", "line": 128, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L128" } ], "type": { @@ -34648,7 +42684,8 @@ { "fileName": "src/lib/types.ts", "line": 127, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L127" } ], "type": { @@ -34678,7 +42715,8 @@ { "fileName": "src/lib/types.ts", "line": 129, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L129" } ], "type": { @@ -34700,7 +42738,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [630, 629, 631] } ], @@ -34708,7 +42745,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ] } @@ -34724,7 +42762,8 @@ { "fileName": "src/lib/types.ts", "line": 131, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L131" } ], "type": { @@ -34736,7 +42775,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [627, 632] } ], @@ -34744,7 +42782,8 @@ { "fileName": "src/lib/types.ts", "line": 125, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L125" } ] } @@ -34768,7 +42807,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ], "type": { @@ -34790,7 +42830,8 @@ { "fileName": "src/lib/types.ts", "line": 136, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L136" } ], "type": { @@ -34808,7 +42849,8 @@ { "fileName": "src/lib/types.ts", "line": 135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L135" } ], "type": { @@ -34820,7 +42862,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [637, 636] } ], @@ -34828,7 +42869,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ] } @@ -34844,12 +42886,13 @@ { "fileName": "src/lib/types.ts", "line": 138, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L138" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -34857,7 +42900,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [634, 638] } ], @@ -34865,7 +42907,8 @@ { "fileName": "src/lib/types.ts", "line": 133, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L133" } ] } @@ -34883,7 +42926,8 @@ { "fileName": "src/lib/types.ts", "line": 156, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L156" } ], "type": { @@ -34908,7 +42952,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ], "type": { @@ -34930,7 +42975,8 @@ { "fileName": "src/lib/types.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L160" } ], "type": { @@ -34949,7 +42995,8 @@ { "fileName": "src/lib/types.ts", "line": 159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L159" } ], "type": { @@ -34962,7 +43009,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [659, 658] } ], @@ -34970,7 +43016,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ] } @@ -34986,7 +43033,8 @@ { "fileName": "src/lib/types.ts", "line": 162, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L162" } ], "type": { @@ -34998,7 +43046,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [656, 660] } ], @@ -35006,7 +43053,8 @@ { "fileName": "src/lib/types.ts", "line": 157, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L157" } ] } @@ -35030,7 +43078,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ], "type": { @@ -35052,7 +43101,8 @@ { "fileName": "src/lib/types.ts", "line": 167, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L167" } ], "type": { @@ -35070,7 +43120,8 @@ { "fileName": "src/lib/types.ts", "line": 166, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L166" } ], "type": { @@ -35082,7 +43133,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [665, 664] } ], @@ -35090,7 +43140,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ] } @@ -35106,12 +43157,13 @@ { "fileName": "src/lib/types.ts", "line": 169, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L169" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -35119,7 +43171,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [662, 666] } ], @@ -35127,7 +43178,8 @@ { "fileName": "src/lib/types.ts", "line": 164, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L164" } ] } @@ -35145,7 +43197,8 @@ { "fileName": "src/lib/types.ts", "line": 172, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L172" } ], "type": { @@ -35170,7 +43223,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ], "type": { @@ -35192,7 +43246,8 @@ { "fileName": "src/lib/types.ts", "line": 176, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L176" } ], "type": { @@ -35211,7 +43266,8 @@ { "fileName": "src/lib/types.ts", "line": 175, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L175" } ], "type": { @@ -35232,7 +43288,8 @@ { "fileName": "src/lib/types.ts", "line": 177, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L177" } ], "type": { @@ -35245,7 +43302,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [672, 671, 673] } ], @@ -35253,7 +43309,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ] } @@ -35269,7 +43326,8 @@ { "fileName": "src/lib/types.ts", "line": 179, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L179" } ], "type": { @@ -35281,7 +43339,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [669, 674] } ], @@ -35289,7 +43346,8 @@ { "fileName": "src/lib/types.ts", "line": 173, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L173" } ] } @@ -35313,7 +43371,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ], "type": { @@ -35335,7 +43394,8 @@ { "fileName": "src/lib/types.ts", "line": 184, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L184" } ], "type": { @@ -35353,7 +43413,8 @@ { "fileName": "src/lib/types.ts", "line": 183, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L183" } ], "type": { @@ -35373,7 +43434,8 @@ { "fileName": "src/lib/types.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L185" } ], "type": { @@ -35385,7 +43447,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [679, 678, 680] } ], @@ -35393,7 +43454,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ] } @@ -35409,12 +43471,13 @@ { "fileName": "src/lib/types.ts", "line": 187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L187" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -35422,7 +43485,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [676, 681] } ], @@ -35430,7 +43492,8 @@ { "fileName": "src/lib/types.ts", "line": 181, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L181" } ] } @@ -35439,7 +43502,7 @@ } }, { - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -35448,7 +43511,8 @@ { "fileName": "src/lib/types.ts", "line": 1008, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1008" } ], "type": { @@ -35466,7 +43530,7 @@ } }, { - "id": 1165, + "id": 1170, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -35475,7 +43539,8 @@ { "fileName": "src/lib/types.ts", "line": 1196, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1196" } ], "type": { @@ -35484,14 +43549,14 @@ { "type": "reflection", "declaration": { - "id": 1166, + "id": 1171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1168, + "id": 1173, "name": "error", "kind": 1024, "kindString": "Property", @@ -35500,7 +43565,8 @@ { "fileName": "src/lib/types.ts", "line": 1199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1199" } ], "type": { @@ -35509,7 +43575,7 @@ } }, { - "id": 1167, + "id": 1172, "name": "session", "kind": 1024, "kindString": "Property", @@ -35518,7 +43584,8 @@ { "fileName": "src/lib/types.ts", "line": 1198, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1198" } ], "type": { @@ -35531,15 +43598,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1168, 1167] + "children": [1173, 1172] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1197, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1197" } ] } @@ -35547,14 +43614,14 @@ { "type": "reflection", "declaration": { - "id": 1169, + "id": 1174, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1171, + "id": 1176, "name": "error", "kind": 1024, "kindString": "Property", @@ -35563,17 +43630,18 @@ { "fileName": "src/lib/types.ts", "line": 1203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } }, { - "id": 1170, + "id": 1175, "name": "session", "kind": 1024, "kindString": "Property", @@ -35582,7 +43650,8 @@ { "fileName": "src/lib/types.ts", "line": 1202, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1202" } ], "type": { @@ -35594,15 +43663,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1171, 1170] + "children": [1176, 1175] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1201, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1201" } ] } @@ -35611,7 +43680,7 @@ } }, { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -35620,7 +43689,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -35654,7 +43724,7 @@ } }, { - "id": 914, + "id": 919, "name": "EthereumWallet", "kind": 4194304, "kindString": "Type alias", @@ -35663,7 +43733,8 @@ { "fileName": "src/lib/types.ts", "line": 678, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L678" } ], "type": { @@ -35672,7 +43743,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -35681,7 +43752,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -35690,14 +43762,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -35706,7 +43778,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -35715,7 +43788,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -35726,20 +43799,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35747,13 +43821,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -35762,7 +43842,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -35773,7 +43853,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -35808,18 +43889,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -35827,13 +43908,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -35845,22 +43932,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -35868,13 +43955,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -35883,7 +43976,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -35891,18 +43984,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -35910,15 +44017,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -35926,14 +44033,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -35942,7 +44049,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -35951,19 +44059,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -35972,7 +44110,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -35983,20 +44121,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36004,13 +44143,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -36022,34 +44167,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -36061,15 +44212,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -36078,7 +44229,7 @@ } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36087,32 +44238,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -36121,19 +44279,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -36142,7 +44306,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -36153,7 +44317,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -36161,7 +44326,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36169,13 +44334,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -36184,7 +44349,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -36205,22 +44371,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36229,32 +44395,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -36263,7 +44436,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -36274,7 +44447,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -36282,7 +44456,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36299,13 +44473,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -36314,7 +44488,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -36335,22 +44510,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36359,14 +44534,15 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { "type": "union", "types": [ { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36375,20 +44551,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -36397,7 +44574,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -36406,7 +44584,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -36417,7 +44595,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -36425,7 +44604,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36442,13 +44621,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -36457,7 +44636,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -36466,7 +44646,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -36475,7 +44655,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -36487,22 +44668,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36511,32 +44692,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -36545,7 +44733,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -36556,7 +44744,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -36564,7 +44753,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36581,13 +44770,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -36596,7 +44785,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -36617,22 +44807,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36641,32 +44831,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -36675,7 +44872,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -36686,7 +44883,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -36694,7 +44892,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36702,13 +44900,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -36717,7 +44915,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -36729,22 +44928,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -36753,32 +44952,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -36787,19 +44993,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -36808,7 +45020,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -36819,7 +45031,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -36827,7 +45040,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -36835,13 +45048,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -36850,7 +45063,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -36871,15 +45085,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } @@ -36889,44 +45103,56 @@ } }, { - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "The properties related to the email link generated" + "summary": [ + { + "kind": "text", + "text": "The properties related to the email link generated" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ], "type": { "type": "reflection", "declaration": { - "id": 1022, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1023, + "id": 1028, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + "summary": [ + { + "kind": "text", + "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 884, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L884" } ], "type": { @@ -36935,19 +45161,25 @@ } }, { - "id": 1024, + "id": 1029, "name": "email_otp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + "summary": [ + { + "kind": "text", + "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 889, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L889" } ], "type": { @@ -36956,19 +45188,25 @@ } }, { - "id": 1025, + "id": 1030, "name": "hashed_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The hashed token appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The hashed token appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 893, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L893" } ], "type": { @@ -36977,19 +45215,25 @@ } }, { - "id": 1026, + "id": 1031, "name": "redirect_to", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The URL appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The URL appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 895, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L895" } ], "type": { @@ -36998,27 +45242,33 @@ } }, { - "id": 1027, + "id": 1032, "name": "verification_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The verification type that the email link is associated to." + "summary": [ + { + "kind": "text", + "text": "The verification type that the email link is associated to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 897, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L897" } ], "type": { "type": "reference", - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "dereferenced": { - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -37027,7 +45277,8 @@ { "fileName": "src/lib/types.ts", "line": 900, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L900" } ], "type": { @@ -37066,22 +45317,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1023, 1024, 1025, 1026, 1027] + "children": [1028, 1029, 1030, 1031, 1032] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ] } } }, { - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -37090,7 +45341,8 @@ { "fileName": "src/lib/types.ts", "line": 862, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L862" } ], "type": { @@ -37099,14 +45351,14 @@ { "type": "reflection", "declaration": { - "id": 1009, + "id": 1014, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1010, + "id": 1015, "name": "data", "kind": 1024, "kindString": "Property", @@ -37115,20 +45367,21 @@ { "fileName": "src/lib/types.ts", "line": 864, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ], "type": { "type": "reflection", "declaration": { - "id": 1011, + "id": 1016, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1012, + "id": 1017, "name": "properties", "kind": 1024, "kindString": "Property", @@ -37137,17 +45390,18 @@ { "fileName": "src/lib/types.ts", "line": 865, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L865" } ], "type": { "type": "reference", - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties" } }, { - "id": 1013, + "id": 1018, "name": "user", "kind": 1024, "kindString": "Property", @@ -37156,7 +45410,8 @@ { "fileName": "src/lib/types.ts", "line": 866, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L866" } ], "type": { @@ -37169,22 +45424,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1012, 1013] + "children": [1017, 1018] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 864, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ] } } }, { - "id": 1014, + "id": 1019, "name": "error", "kind": 1024, "kindString": "Property", @@ -37193,7 +45448,8 @@ { "fileName": "src/lib/types.ts", "line": 868, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L868" } ], "type": { @@ -37205,15 +45461,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1010, 1014] + "children": [1015, 1019] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 863, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L863" } ] } @@ -37221,14 +45477,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1021, "name": "data", "kind": 1024, "kindString": "Property", @@ -37237,20 +45493,21 @@ { "fileName": "src/lib/types.ts", "line": 871, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ], "type": { "type": "reflection", "declaration": { - "id": 1017, + "id": 1022, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1018, + "id": 1023, "name": "properties", "kind": 1024, "kindString": "Property", @@ -37259,7 +45516,8 @@ { "fileName": "src/lib/types.ts", "line": 872, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L872" } ], "type": { @@ -37268,7 +45526,7 @@ } }, { - "id": 1019, + "id": 1024, "name": "user", "kind": 1024, "kindString": "Property", @@ -37277,7 +45535,8 @@ { "fileName": "src/lib/types.ts", "line": 873, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L873" } ], "type": { @@ -37289,22 +45548,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1018, 1019] + "children": [1023, 1024] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 871, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ] } } }, { - "id": 1020, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -37313,12 +45572,13 @@ { "fileName": "src/lib/types.ts", "line": 875, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L875" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -37326,15 +45586,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1016, 1020] + "children": [1021, 1025] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 870, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L870" } ] } @@ -37343,7 +45603,7 @@ } }, { - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -37352,7 +45612,8 @@ { "fileName": "src/lib/types.ts", "line": 900, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L900" } ], "type": { @@ -37386,7 +45647,7 @@ } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -37395,32 +45656,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -37429,7 +45697,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -37440,7 +45708,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -37448,7 +45717,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -37456,13 +45725,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -37471,7 +45740,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -37483,22 +45753,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -37507,20 +45777,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -37529,7 +45800,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -37538,7 +45810,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -37549,7 +45821,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -37557,7 +45830,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -37574,13 +45847,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -37589,7 +45862,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -37598,7 +45872,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -37607,7 +45881,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -37619,15 +45894,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } @@ -37643,7 +45918,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ], "type": { @@ -37667,7 +45943,8 @@ { "fileName": "src/lib/types.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L70" } ], "type": { @@ -37687,7 +45964,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "type": { @@ -37709,7 +45987,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "signatures": [ @@ -37771,7 +46050,8 @@ { "fileName": "src/lib/types.ts", "line": 68, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L68" } ], "type": { @@ -37791,7 +46071,8 @@ { "fileName": "src/lib/types.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L84" } ], "type": { @@ -37811,15 +46092,16 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L86" } ], "type": { "type": "reference", - "id": 861, + "id": 863, "name": "AuthFlowType", "dereferenced": { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -37828,7 +46110,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -37856,19 +46139,20 @@ "isOptional": true }, "comment": { - "shortText": "Set to \"true\" if there is a custom authorization header set globally.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Set to \"true\" if there is a custom authorization header set globally." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L99" } ], "type": { @@ -37888,7 +46172,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "type": { @@ -37903,7 +46188,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "indexSignature": { @@ -37941,19 +46227,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L94" } ], "type": { @@ -37970,7 +46257,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -37985,7 +46273,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -37996,13 +46285,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -38021,7 +46318,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -38035,7 +46337,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -38049,7 +46364,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -38063,7 +46383,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -38082,9 +46403,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38101,9 +46422,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38124,7 +46445,8 @@ { "fileName": "src/lib/types.ts", "line": 72, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L72" } ], "type": { @@ -38144,15 +46466,16 @@ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L74" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -38161,7 +46484,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -38175,9 +46499,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -38197,9 +46521,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -38207,14 +46531,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -38222,13 +46546,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -38240,15 +46578,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -38270,7 +46608,8 @@ { "fileName": "src/lib/types.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L66" } ], "type": { @@ -38290,7 +46629,8 @@ { "fileName": "src/lib/types.ts", "line": 62, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L62" } ], "type": { @@ -38307,28 +46647,68 @@ "isOptional": true }, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, `storage` will only store a JSON object containing the access and refresh token and some adjacent metadata, while `userStorage` will only contain the user object under the key `storageKey + '-user'`.", - "text": "When this option is set and cookie storage is used, `getSession()` and other functions that load a session from the cookie store might not return back a user. It's very important to always use `getUser()` to fetch a user object in those scenarios.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " + }, + { + "kind": "code", + "text": "`storage`" + }, + { + "kind": "text", + "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " + }, + { + "kind": "code", + "text": "`userStorage`" + }, + { + "kind": "text", + "text": " will only contain the user object under the key " + }, + { + "kind": "code", + "text": "`storageKey + '-user'`" + }, + { + "kind": "text", + "text": ".\n\nWhen this option is set and cookie storage is used, " + }, + { + "kind": "code", + "text": "`getSession()`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " + }, + { + "kind": "code", + "text": "`getUser()`" + }, + { + "kind": "text", + "text": " to fetch a user object in those scenarios." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L82" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -38337,7 +46717,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -38351,9 +46732,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -38373,9 +46754,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -38383,14 +46764,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -38398,13 +46779,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -38416,15 +46811,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -38438,7 +46833,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [593, 599, 592, 597, 598, 605, 587, 604, 594, 595, 591, 586, 596] } ], @@ -38446,14 +46840,15 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ] } } }, { - "id": 1162, + "id": 1167, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -38462,20 +46857,21 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { "type": "reflection", "declaration": { - "id": 1163, + "id": 1168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1164, + "id": 1169, "name": "error", "kind": 1024, "kindString": "Property", @@ -38484,7 +46880,8 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { @@ -38492,7 +46889,7 @@ "types": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" }, { @@ -38506,22 +46903,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1164] + "children": [1169] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ] } } }, { - "id": 1224, + "id": 1229, "name": "JwtHeader", "kind": 4194304, "kindString": "Type alias", @@ -38530,20 +46927,21 @@ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ], "type": { "type": "reflection", "declaration": { - "id": 1225, + "id": 1230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1231, "name": "alg", "kind": 1024, "kindString": "Property", @@ -38552,7 +46950,8 @@ { "fileName": "src/lib/types.ts", "line": 1309, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1309" } ], "type": { @@ -38574,7 +46973,7 @@ } }, { - "id": 1227, + "id": 1232, "name": "kid", "kind": 1024, "kindString": "Property", @@ -38583,7 +46982,8 @@ { "fileName": "src/lib/types.ts", "line": 1310, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1310" } ], "type": { @@ -38592,7 +46992,7 @@ } }, { - "id": 1228, + "id": 1233, "name": "typ", "kind": 1024, "kindString": "Property", @@ -38601,7 +47001,8 @@ { "fileName": "src/lib/types.ts", "line": 1311, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1311" } ], "type": { @@ -38613,22 +47014,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1226, 1227, 1228] + "children": [1231, 1232, 1233] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 24 + "character": 24, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ] } } }, { - "id": 1239, + "id": 1244, "name": "JwtPayload", "kind": 4194304, "kindString": "Type alias", @@ -38637,7 +47038,8 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "type": { @@ -38645,13 +47047,13 @@ "types": [ { "type": "reference", - "id": 1229, + "id": 1234, "name": "RequiredClaims" }, { "type": "reflection", "declaration": { - "id": 1240, + "id": 1245, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -38660,18 +47062,19 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "indexSignature": { - "id": 1241, + "id": 1246, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1242, + "id": 1247, "name": "key", "kind": 32768, "flags": {}, @@ -38701,7 +47104,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -38716,7 +47120,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -38727,13 +47132,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -38752,7 +47165,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -38766,7 +47184,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -38780,7 +47211,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -38794,7 +47230,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -38813,9 +47250,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38832,9 +47269,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38842,7 +47279,7 @@ } }, { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -38851,32 +47288,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -38885,19 +47329,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -38909,22 +47359,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } } }, { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -38933,20 +47383,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -38954,13 +47405,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -38978,19 +47435,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -39002,22 +47465,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } } }, { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -39026,14 +47489,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -39042,32 +47506,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -39076,7 +47547,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -39084,13 +47555,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -39099,7 +47576,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -39107,13 +47584,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -39125,22 +47608,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -39149,32 +47632,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -39183,7 +47673,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -39191,13 +47681,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -39206,19 +47702,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -39230,15 +47732,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -39248,7 +47750,7 @@ } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -39257,32 +47759,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -39291,7 +47800,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -39299,13 +47808,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -39314,19 +47829,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -39338,22 +47859,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } } }, { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -39362,32 +47883,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -39396,7 +47924,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -39404,13 +47932,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -39419,7 +47953,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -39427,13 +47961,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -39445,22 +47985,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -39469,32 +48009,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -39506,22 +48053,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } } }, { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -39530,32 +48077,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -39564,19 +48118,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -39585,19 +48145,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -39609,22 +48175,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } } }, { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -39633,7 +48199,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -39660,7 +48227,8 @@ { "fileName": "src/lib/types.ts", "line": 190, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L190" } ], "type": { @@ -39685,7 +48253,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ], "type": { @@ -39707,7 +48276,8 @@ { "fileName": "src/lib/types.ts", "line": 193, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L193" } ], "type": { @@ -39726,7 +48296,8 @@ { "fileName": "src/lib/types.ts", "line": 194, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L194" } ], "type": { @@ -39738,7 +48309,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [686, 687] } ], @@ -39746,7 +48316,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ] } @@ -39762,7 +48333,8 @@ { "fileName": "src/lib/types.ts", "line": 196, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L196" } ], "type": { @@ -39774,7 +48346,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [684, 688] } ], @@ -39782,7 +48353,8 @@ { "fileName": "src/lib/types.ts", "line": 191, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L191" } ] } @@ -39806,7 +48378,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ], "type": { @@ -39828,7 +48401,8 @@ { "fileName": "src/lib/types.ts", "line": 200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L200" } ], "type": { @@ -39847,7 +48421,8 @@ { "fileName": "src/lib/types.ts", "line": 201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L201" } ], "type": { @@ -39859,7 +48434,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [692, 693] } ], @@ -39867,7 +48441,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ] } @@ -39883,12 +48458,13 @@ { "fileName": "src/lib/types.ts", "line": 203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -39896,7 +48472,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [690, 694] } ], @@ -39904,7 +48479,8 @@ { "fileName": "src/lib/types.ts", "line": 198, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L198" } ] } @@ -39913,7 +48489,7 @@ } }, { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -39922,20 +48498,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -39943,13 +48520,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -39958,7 +48541,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -39966,13 +48549,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -39984,22 +48573,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } } }, { - "id": 1172, + "id": 1177, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -40008,20 +48597,21 @@ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "type": { "type": "reflection", "declaration": { - "id": 1173, + "id": 1178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1175, + "id": 1180, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -40030,7 +48620,8 @@ { "fileName": "src/lib/types.ts", "line": 1209, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1209" } ], "type": { @@ -40039,7 +48630,7 @@ } }, { - "id": 1174, + "id": 1179, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -40048,7 +48639,8 @@ { "fileName": "src/lib/types.ts", "line": 1208, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1208" } ], "type": { @@ -40066,7 +48658,7 @@ } }, { - "id": 1176, + "id": 1181, "name": "total", "kind": 1024, "kindString": "Property", @@ -40075,7 +48667,8 @@ { "fileName": "src/lib/types.ts", "line": 1210, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1210" } ], "type": { @@ -40087,26 +48680,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1175, 1174, 1176] + "children": [1180, 1179, 1181] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "indexSignature": { - "id": 1177, + "id": 1182, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1178, + "id": 1183, "name": "key", "kind": 32768, "flags": {}, @@ -40131,13 +48724,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -40235,7 +48834,7 @@ } }, { - "id": 1229, + "id": 1234, "name": "RequiredClaims", "kind": 4194304, "kindString": "Type alias", @@ -40244,20 +48843,21 @@ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ], "type": { "type": "reflection", "declaration": { - "id": 1230, + "id": 1235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1237, + "id": 1242, "name": "aal", "kind": 1024, "kindString": "Property", @@ -40266,15 +48866,16 @@ { "fileName": "src/lib/types.ts", "line": 1321, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1321" } ], "type": { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "dereferenced": { - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -40283,7 +48884,8 @@ { "fileName": "src/lib/types.ts", "line": 1008, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1008" } ], "type": { @@ -40303,7 +48905,7 @@ } }, { - "id": 1233, + "id": 1238, "name": "aud", "kind": 1024, "kindString": "Property", @@ -40312,7 +48914,8 @@ { "fileName": "src/lib/types.ts", "line": 1317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1317" } ], "type": { @@ -40333,7 +48936,7 @@ } }, { - "id": 1234, + "id": 1239, "name": "exp", "kind": 1024, "kindString": "Property", @@ -40342,7 +48945,8 @@ { "fileName": "src/lib/types.ts", "line": 1318, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1318" } ], "type": { @@ -40351,7 +48955,7 @@ } }, { - "id": 1235, + "id": 1240, "name": "iat", "kind": 1024, "kindString": "Property", @@ -40360,7 +48964,8 @@ { "fileName": "src/lib/types.ts", "line": 1319, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1319" } ], "type": { @@ -40369,7 +48974,7 @@ } }, { - "id": 1231, + "id": 1236, "name": "iss", "kind": 1024, "kindString": "Property", @@ -40378,7 +48983,8 @@ { "fileName": "src/lib/types.ts", "line": 1315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1315" } ], "type": { @@ -40387,7 +48993,7 @@ } }, { - "id": 1236, + "id": 1241, "name": "role", "kind": 1024, "kindString": "Property", @@ -40396,7 +49002,8 @@ { "fileName": "src/lib/types.ts", "line": 1320, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1320" } ], "type": { @@ -40405,7 +49012,7 @@ } }, { - "id": 1238, + "id": 1243, "name": "session_id", "kind": 1024, "kindString": "Property", @@ -40414,7 +49021,8 @@ { "fileName": "src/lib/types.ts", "line": 1322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1322" } ], "type": { @@ -40423,7 +49031,7 @@ } }, { - "id": 1232, + "id": 1237, "name": "sub", "kind": 1024, "kindString": "Property", @@ -40432,7 +49040,8 @@ { "fileName": "src/lib/types.ts", "line": 1316, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1316" } ], "type": { @@ -40444,22 +49053,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1237, 1233, 1234, 1235, 1231, 1236, 1238, 1232] + "children": [1242, 1238, 1239, 1240, 1236, 1241, 1243, 1237] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ] } } }, { - "id": 955, + "id": 960, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -40468,7 +49077,8 @@ { "fileName": "src/lib/types.ts", "line": 769, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L769" } ], "type": { @@ -40477,14 +49087,14 @@ { "type": "reflection", "declaration": { - "id": 956, + "id": 961, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 963, "name": "email", "kind": 1024, "kindString": "Property", @@ -40493,7 +49103,8 @@ { "fileName": "src/lib/types.ts", "line": 772, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L772" } ], "type": { @@ -40502,7 +49113,7 @@ } }, { - "id": 959, + "id": 964, "name": "options", "kind": 1024, "kindString": "Property", @@ -40513,20 +49124,21 @@ { "fileName": "src/lib/types.ts", "line": 773, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ], "type": { "type": "reflection", "declaration": { - "id": 960, + "id": 965, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 962, + "id": 967, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -40534,13 +49146,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L777" } ], "type": { @@ -40549,7 +49167,7 @@ } }, { - "id": 961, + "id": 966, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -40557,13 +49175,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 775, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L775" } ], "type": { @@ -40575,22 +49199,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [962, 961] + "children": [967, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 773, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ] } } }, { - "id": 957, + "id": 962, "name": "type", "kind": 1024, "kindString": "Property", @@ -40599,7 +49223,8 @@ { "fileName": "src/lib/types.ts", "line": 771, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L771" } ], "type": { @@ -40607,7 +49232,7 @@ "typeArguments": [ { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" }, { @@ -40624,24 +49249,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [958, 959, 957] + "children": [963, 964, 962] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 770, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L770" } ] } @@ -40649,14 +49274,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 966, + "id": 971, "name": "options", "kind": 1024, "kindString": "Property", @@ -40667,20 +49292,21 @@ { "fileName": "src/lib/types.ts", "line": 783, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ], "type": { "type": "reflection", "declaration": { - "id": 967, + "id": 972, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 968, + "id": 973, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -40688,13 +49314,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L785" } ], "type": { @@ -40706,22 +49338,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [968] + "children": [973] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 783, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ] } } }, { - "id": 965, + "id": 970, "name": "phone", "kind": 1024, "kindString": "Property", @@ -40730,7 +49362,8 @@ { "fileName": "src/lib/types.ts", "line": 782, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L782" } ], "type": { @@ -40739,7 +49372,7 @@ } }, { - "id": 964, + "id": 969, "name": "type", "kind": 1024, "kindString": "Property", @@ -40748,7 +49381,8 @@ { "fileName": "src/lib/types.ts", "line": 781, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L781" } ], "type": { @@ -40756,7 +49390,7 @@ "typeArguments": [ { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" }, { @@ -40773,24 +49407,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [966, 965, 964] + "children": [971, 970, 969] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 780, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L780" } ] } @@ -40808,7 +49442,8 @@ { "fileName": "src/lib/types.ts", "line": 206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L206" } ], "type": { @@ -40833,7 +49468,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ], "type": { @@ -40852,14 +49488,27 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.", - "text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n" + "summary": [ + { + "kind": "text", + "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " + }, + { + "kind": "code", + "text": "`window.location.href`" + }, + { + "kind": "text", + "text": " to take\nthe user to the authentication flow." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 216, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L216" } ], "type": { @@ -40871,7 +49520,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [699] } ], @@ -40879,7 +49527,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ] } @@ -40895,7 +49544,8 @@ { "fileName": "src/lib/types.ts", "line": 218, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L218" } ], "type": { @@ -40907,7 +49557,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [697, 700] } ], @@ -40915,7 +49564,8 @@ { "fileName": "src/lib/types.ts", "line": 207, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L207" } ] } @@ -40939,7 +49589,8 @@ { "fileName": "src/lib/types.ts", "line": 221, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L221" } ], "type": { @@ -40957,12 +49608,13 @@ { "fileName": "src/lib/types.ts", "line": 222, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -40970,7 +49622,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [702, 703] } ], @@ -40978,7 +49629,8 @@ { "fileName": "src/lib/types.ts", "line": 220, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L220" } ] } @@ -40987,7 +49639,7 @@ } }, { - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -40996,20 +49648,21 @@ { "fileName": "src/lib/types.ts", "line": 490, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ], "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 812, "name": "options", "kind": 1024, "kindString": "Property", @@ -41020,20 +49673,21 @@ { "fileName": "src/lib/types.ts", "line": 491, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ], "type": { "type": "reflection", "declaration": { - "id": 811, + "id": 813, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 813, + "id": 815, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -41041,13 +49695,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 499, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L499" } ], "type": { @@ -41056,7 +49716,7 @@ } }, { - "id": 812, + "id": 814, "name": "data", "kind": 1024, "kindString": "Property", @@ -41064,14 +49724,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 497, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L497" } ], "type": { @@ -41083,15 +49764,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [813, 812] + "children": [815, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 491, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ] } @@ -41101,22 +49782,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [810] + "children": [812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 490, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ] } } }, { - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -41125,20 +49806,21 @@ { "fileName": "src/lib/types.ts", "line": 617, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ], "type": { "type": "reflection", "declaration": { - "id": 875, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 881, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -41146,13 +49828,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L623" } ], "type": { @@ -41161,7 +49857,7 @@ } }, { - "id": 880, + "id": 882, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -41169,13 +49865,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L625" } ], "type": { @@ -41184,7 +49894,7 @@ } }, { - "id": 881, + "id": 883, "name": "options", "kind": 1024, "kindString": "Property", @@ -41195,20 +49905,21 @@ { "fileName": "src/lib/types.ts", "line": 626, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ], "type": { "type": "reflection", "declaration": { - "id": 882, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 883, + "id": 885, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -41216,13 +49927,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 628, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L628" } ], "type": { @@ -41234,34 +49951,96 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [883] + "children": [885] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 626, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ] } } }, { - "id": 876, + "id": 878, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)." + "summary": [ + { + "kind": "text", + "text": "Provider name or OIDC " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " value identifying which provider should be used to verify the provided token. Supported names: " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`apple`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`azure`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`facebook`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`kakao`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`keycloak`" + }, + { + "kind": "text", + "text": " (deprecated)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 619, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ], "type": { @@ -41297,7 +50076,7 @@ { "type": "reflection", "declaration": { - "id": 877, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -41306,7 +50085,8 @@ { "fileName": "src/lib/types.ts", "line": 619, - "character": 76 + "character": 76, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ] } @@ -41317,19 +50097,57 @@ } }, { - "id": 878, + "id": 880, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." + "summary": [ + { + "kind": "text", + "text": "OIDC ID token issued by the specified provider. The " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " which require that you provide an " + }, + { + "kind": "code", + "text": "`access_token`" + }, + { + "kind": "text", + "text": " value to be accepted properly. If the token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim you must supply the nonce used to obtain the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 621, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L621" } ], "type": { @@ -41341,22 +50159,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [879, 880, 881, 876, 878] + "children": [881, 882, 883, 878, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 617, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ] } } }, { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -41365,20 +50183,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -41389,20 +50208,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -41410,19 +50230,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -41431,18 +50257,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -41461,7 +50288,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -41469,13 +50296,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -41484,7 +50317,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -41492,13 +50325,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -41507,7 +50346,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -41515,13 +50354,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -41533,34 +50378,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -41574,13 +50425,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -41683,22 +50540,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } } }, { - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -41707,7 +50564,8 @@ { "fileName": "src/lib/types.ts", "line": 541, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L541" } ], "type": { @@ -41716,26 +50574,32 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 835, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 544, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L544" } ], "type": { @@ -41744,7 +50608,7 @@ } }, { - "id": 835, + "id": 837, "name": "options", "kind": 1024, "kindString": "Property", @@ -41755,20 +50619,21 @@ { "fileName": "src/lib/types.ts", "line": 547, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ], "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -41776,13 +50641,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L549" } ], "type": { @@ -41794,34 +50665,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [837] + "children": [839] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 547, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ] } } }, { - "id": 834, + "id": 836, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 546, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L546" } ], "type": { @@ -41833,15 +50710,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [833, 835, 834] + "children": [835, 837, 836] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 542, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L542" } ] } @@ -41849,14 +50726,14 @@ { "type": "reflection", "declaration": { - "id": 838, + "id": 840, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 843, "name": "options", "kind": 1024, "kindString": "Property", @@ -41867,20 +50744,21 @@ { "fileName": "src/lib/types.ts", "line": 557, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 843, + "id": 845, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -41888,13 +50766,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L559" } ], "type": { @@ -41906,34 +50790,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [843] + "children": [845] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 557, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ] } } }, { - "id": 840, + "id": 842, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 556, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L556" } ], "type": { @@ -41942,19 +50832,25 @@ } }, { - "id": 839, + "id": 841, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 554, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L554" } ], "type": { @@ -41966,15 +50862,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [841, 840, 839] + "children": [843, 842, 841] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 552, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L552" } ] } @@ -41983,7 +50879,7 @@ } }, { - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -41992,7 +50888,8 @@ { "fileName": "src/lib/types.ts", "line": 563, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L563" } ], "type": { @@ -42001,26 +50898,32 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L566" } ], "type": { @@ -42029,7 +50932,7 @@ } }, { - "id": 847, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -42040,20 +50943,21 @@ { "fileName": "src/lib/types.ts", "line": 567, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ], "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 852, + "id": 854, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -42061,13 +50965,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 579, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L579" } ], "type": { @@ -42076,7 +50986,7 @@ } }, { - "id": 851, + "id": 853, "name": "data", "kind": 1024, "kindString": "Property", @@ -42084,14 +50994,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L577" } ], "type": { @@ -42100,7 +51031,7 @@ } }, { - "id": 849, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -42108,13 +51039,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L569" } ], "type": { @@ -42123,7 +51060,7 @@ } }, { - "id": 850, + "id": 852, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -42131,13 +51068,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L571" } ], "type": { @@ -42149,15 +51092,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [852, 851, 849, 850] + "children": [854, 853, 851, 852] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 567, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ] } @@ -42167,15 +51110,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [846, 847] + "children": [848, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 564, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L564" } ] } @@ -42183,14 +51126,14 @@ { "type": "reflection", "declaration": { - "id": 853, + "id": 855, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 855, + "id": 857, "name": "options", "kind": 1024, "kindString": "Property", @@ -42201,20 +51144,21 @@ { "fileName": "src/lib/types.ts", "line": 585, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ], "type": { "type": "reflection", "declaration": { - "id": 856, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 861, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -42222,13 +51166,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 595, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L595" } ], "type": { @@ -42237,7 +51187,7 @@ } }, { - "id": 860, + "id": 862, "name": "channel", "kind": 1024, "kindString": "Property", @@ -42245,13 +51195,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 597, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L597" } ], "type": { @@ -42269,7 +51225,7 @@ } }, { - "id": 858, + "id": 860, "name": "data", "kind": 1024, "kindString": "Property", @@ -42277,14 +51233,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 593, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L593" } ], "type": { @@ -42293,7 +51270,7 @@ } }, { - "id": 857, + "id": 859, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -42301,13 +51278,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L587" } ], "type": { @@ -42319,34 +51302,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [859, 860, 858, 857] + "children": [861, 862, 860, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 585, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ] } } }, { - "id": 854, + "id": 856, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 584, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L584" } ], "type": { @@ -42358,15 +51347,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [855, 854] + "children": [857, 856] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 582, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L582" } ] } @@ -42375,7 +51364,7 @@ } }, { - "id": 969, + "id": 974, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -42384,7 +51373,8 @@ { "fileName": "src/lib/types.ts", "line": 789, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L789" } ], "type": { @@ -42393,14 +51383,14 @@ { "type": "reflection", "declaration": { - "id": 970, + "id": 975, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 972, + "id": 977, "name": "options", "kind": 1024, "kindString": "Property", @@ -42411,20 +51401,21 @@ { "fileName": "src/lib/types.ts", "line": 794, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ], "type": { "type": "reflection", "declaration": { - "id": 973, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 975, + "id": 980, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -42432,13 +51423,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 798, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L798" } ], "type": { @@ -42447,7 +51444,7 @@ } }, { - "id": 974, + "id": 979, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -42455,13 +51452,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L796" } ], "type": { @@ -42473,34 +51476,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [975, 974] + "children": [980, 979] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ] } } }, { - "id": 971, + "id": 976, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." + "summary": [ + { + "kind": "text", + "text": "UUID of the SSO provider to invoke single-sign on to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 792, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L792" } ], "type": { @@ -42512,15 +51521,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [972, 971] + "children": [977, 976] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 790, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L790" } ] } @@ -42528,26 +51537,32 @@ { "type": "reflection", "declaration": { - "id": 976, + "id": 981, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 977, + "id": 982, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." + "summary": [ + { + "kind": "text", + "text": "Domain name of the organization for which to invoke single-sign on." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 803, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L803" } ], "type": { @@ -42556,7 +51571,7 @@ } }, { - "id": 978, + "id": 983, "name": "options", "kind": 1024, "kindString": "Property", @@ -42567,20 +51582,21 @@ { "fileName": "src/lib/types.ts", "line": 805, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ], "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 984, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 981, + "id": 986, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -42588,13 +51604,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 809, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L809" } ], "type": { @@ -42603,7 +51625,7 @@ } }, { - "id": 980, + "id": 985, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -42611,13 +51633,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L807" } ], "type": { @@ -42629,15 +51657,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [981, 980] + "children": [986, 985] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 805, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ] } @@ -42647,15 +51675,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [977, 978] + "children": [982, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 801, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L801" } ] } @@ -42664,7 +51692,7 @@ } }, { - "id": 1183, + "id": 1188, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -42673,20 +51701,21 @@ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ], "type": { "type": "reflection", "declaration": { - "id": 1184, + "id": 1189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1185, + "id": 1190, "name": "scope", "kind": 1024, "kindString": "Property", @@ -42694,13 +51723,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + "summary": [ + { + "kind": "text", + "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1231, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1231" } ], "type": { @@ -42725,22 +51760,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1185] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ] } } }, { - "id": 1251, + "id": 1256, "name": "SignOutScope", "kind": 4194304, "kindString": "Type alias", @@ -42749,7 +51784,8 @@ { "fileName": "src/lib/types.ts", "line": 1338, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1338" } ], "type": { @@ -42762,14 +51798,14 @@ "type": "query", "queryType": { "type": "reference", - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES" } } } }, { - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -42778,7 +51814,8 @@ { "fileName": "src/lib/types.ts", "line": 503, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L503" } ], "type": { @@ -42787,26 +51824,32 @@ { "type": "reflection", "declaration": { - "id": 815, + "id": 817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 818, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 506, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L506" } ], "type": { @@ -42815,7 +51858,7 @@ } }, { - "id": 818, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -42826,20 +51869,21 @@ { "fileName": "src/lib/types.ts", "line": 509, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ], "type": { "type": "reflection", "declaration": { - "id": 819, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 822, + "id": 824, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -42847,13 +51891,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 519, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L519" } ], "type": { @@ -42862,7 +51912,7 @@ } }, { - "id": 821, + "id": 823, "name": "data", "kind": 1024, "kindString": "Property", @@ -42870,14 +51920,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 517, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L517" } ], "type": { @@ -42886,7 +51957,7 @@ } }, { - "id": 820, + "id": 822, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -42894,13 +51965,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L511" } ], "type": { @@ -42912,34 +51989,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [822, 821, 820] + "children": [824, 823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 509, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ] } } }, { - "id": 817, + "id": 819, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L508" } ], "type": { @@ -42951,15 +52034,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [816, 818, 817] + "children": [818, 820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 504, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L504" } ] } @@ -42967,14 +52050,14 @@ { "type": "reflection", "declaration": { - "id": 823, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 826, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -42985,20 +52068,21 @@ { "fileName": "src/lib/types.ts", "line": 527, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -43006,13 +52090,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L535" } ], "type": { @@ -43021,7 +52111,7 @@ } }, { - "id": 830, + "id": 832, "name": "channel", "kind": 1024, "kindString": "Property", @@ -43029,13 +52119,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 537, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L537" } ], "type": { @@ -43053,7 +52149,7 @@ } }, { - "id": 828, + "id": 830, "name": "data", "kind": 1024, "kindString": "Property", @@ -43061,14 +52157,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L533" } ], "type": { @@ -43080,34 +52197,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [829, 830, 828] + "children": [831, 832, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 527, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ] } } }, { - "id": 825, + "id": 827, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 526, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L526" } ], "type": { @@ -43116,19 +52239,25 @@ } }, { - "id": 824, + "id": 826, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 524, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L524" } ], "type": { @@ -43140,15 +52269,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [826, 825, 824] + "children": [828, 827, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 522, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L522" } ] } @@ -43157,7 +52286,7 @@ } }, { - "id": 884, + "id": 886, "name": "SolanaWallet", "kind": 4194304, "kindString": "Type alias", @@ -43166,20 +52295,21 @@ { "fileName": "src/lib/types.ts", "line": 632, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ], "type": { "type": "reflection", "declaration": { - "id": 885, + "id": 887, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 889, + "id": 892, "name": "publicKey", "kind": 1024, "kindString": "Property", @@ -43190,7 +52320,8 @@ { "fileName": "src/lib/types.ts", "line": 634, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ], "type": { @@ -43199,52 +52330,71 @@ { "type": "reflection", "declaration": { - "id": 890, + "id": 893, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 891, + "id": 894, "name": "toBase58", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 635, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" } ], - "signatures": [ - { - "id": 892, - "name": "toBase58", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 895, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 635, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" + } + ], + "signatures": [ + { + "id": 896, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } - ] + } } ], "groups": [ { - "title": "Methods", - "kind": 2048, - "children": [891] + "title": "Properties", + "children": [894] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 634, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ] } @@ -43257,10 +52407,10 @@ } }, { - "id": 886, + "id": 888, "name": "signIn", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -43268,66 +52418,85 @@ { "fileName": "src/lib/types.ts", "line": 633, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "signatures": [ - { - "id": 887, - "name": "signIn", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 889, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ + "sources": [ { - "id": 888, - "name": "inputs", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "SolanaSignInInput" - } - } + "fileName": "src/lib/types.ts", + "line": 633, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "SolanaSignInOutput" + "signatures": [ + { + "id": 890, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 891, + "name": "inputs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isRest": true }, - { + "type": { "type": "array", "elementType": { "type": "reference", - "name": "SolanaSignInOutput" + "name": "SolanaSignInInput" } } - ] + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "SolanaSignInOutput" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "SolanaSignInOutput" + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + } + ] } - ] + } }, { - "id": 893, + "id": 897, "name": "signMessage", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -43335,95 +52504,118 @@ { "fileName": "src/lib/types.ts", "line": 638, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "signatures": [ - { - "id": 894, - "name": "signMessage", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 898, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ - { - "id": 895, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - }, + "sources": [ { - "id": 896, - "name": "encoding", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/lib/types.ts", + "line": 638, + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 899, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 900, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + }, + { + "id": 901, + "name": "encoding", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "utf8" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Uint8Array", + "qualifiedName": "Uint8Array", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] } - ] - } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [889] - }, - { - "title": "Methods", - "kind": 2048, - "children": [886, 893] + "children": [892, 888, 897] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 632, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ] } } }, { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -43432,7 +52624,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -43441,14 +52634,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -43457,7 +52650,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -43466,7 +52660,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -43477,20 +52671,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -43498,13 +52693,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -43513,7 +52714,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -43524,7 +52725,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -43563,18 +52765,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -43582,13 +52784,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -43600,22 +52808,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -43623,13 +52831,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -43638,7 +52852,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -43646,18 +52860,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -43665,15 +52893,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -43681,14 +52909,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -43697,7 +52925,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -43706,19 +52935,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -43727,7 +52986,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -43738,20 +52997,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -43759,13 +53019,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -43777,56 +53043,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -43835,7 +53107,7 @@ } }, { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -43844,7 +53116,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -43858,9 +53131,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -43880,9 +53153,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -43890,14 +53163,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -43905,13 +53178,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -43923,15 +53210,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -43949,7 +53236,8 @@ { "fileName": "src/lib/types.ts", "line": 225, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L225" } ], "type": { @@ -43974,7 +53262,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ], "type": { @@ -43996,7 +53285,8 @@ { "fileName": "src/lib/types.ts", "line": 228, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L228" } ], "type": { @@ -44009,7 +53299,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [708] } ], @@ -44017,7 +53306,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ] } @@ -44033,7 +53323,8 @@ { "fileName": "src/lib/types.ts", "line": 230, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L230" } ], "type": { @@ -44045,7 +53336,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [706, 709] } ], @@ -44053,7 +53343,8 @@ { "fileName": "src/lib/types.ts", "line": 226, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L226" } ] } @@ -44077,7 +53368,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ], "type": { @@ -44099,7 +53391,8 @@ { "fileName": "src/lib/types.ts", "line": 234, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L234" } ], "type": { @@ -44111,7 +53404,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [713] } ], @@ -44119,7 +53411,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ] } @@ -44135,12 +53428,13 @@ { "fileName": "src/lib/types.ts", "line": 236, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L236" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -44148,7 +53442,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [711, 714] } ], @@ -44156,7 +53449,8 @@ { "fileName": "src/lib/types.ts", "line": 232, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L232" } ] } @@ -44165,7 +53459,7 @@ } }, { - "id": 933, + "id": 938, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -44174,21 +53468,22 @@ { "fileName": "src/lib/types.ts", "line": 719, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L719" } ], "type": { "type": "union", "types": [ { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -44199,20 +53494,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -44220,11 +53516,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "\n" + "tag": "@deprecated", + "content": [] } ] }, @@ -44232,7 +53533,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -44241,7 +53543,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -44249,13 +53551,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -44267,27 +53575,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -44296,19 +53617,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -44317,27 +53644,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -44346,7 +53679,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -44369,39 +53703,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -44410,7 +53750,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -44421,20 +53761,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -44442,11 +53783,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -44454,7 +53800,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -44463,7 +53810,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -44471,13 +53818,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -44489,27 +53842,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -44518,27 +53884,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -44547,7 +53919,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -44586,39 +53959,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -44627,27 +54006,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -44656,7 +54041,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -44695,15 +54081,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] } @@ -44720,7 +54106,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ], "type": { @@ -44742,7 +54129,8 @@ { "fileName": "src/lib/types.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L105" } ], "type": { @@ -44760,7 +54148,8 @@ { "fileName": "src/lib/types.ts", "line": 104, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L104" } ], "type": { @@ -44776,7 +54165,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [611, 610] } ], @@ -44784,7 +54172,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ] } @@ -44800,7 +54189,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ], "type": { @@ -44837,7 +54227,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 80 + "character": 80, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ] } @@ -44848,7 +54239,7 @@ } }, { - "id": 932, + "id": 937, "name": "Web3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -44857,14 +54248,15 @@ { "fileName": "src/lib/types.ts", "line": 717, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L717" } ], "type": { "type": "union", "types": [ { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -44873,7 +54265,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -44882,14 +54275,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -44898,7 +54291,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -44907,7 +54301,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -44918,20 +54312,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -44939,13 +54334,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -44954,7 +54355,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -44965,7 +54366,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -45004,18 +54406,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -45023,13 +54425,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -45041,22 +54449,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -45064,13 +54472,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -45079,7 +54493,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -45087,18 +54501,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -45106,15 +54534,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -45122,14 +54550,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -45138,7 +54566,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -45147,19 +54576,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -45168,7 +54627,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -45179,20 +54638,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -45200,13 +54660,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -45218,56 +54684,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -45276,7 +54748,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -45285,7 +54757,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -45294,14 +54767,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -45310,7 +54783,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -45319,7 +54793,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -45330,20 +54804,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -45351,13 +54826,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -45366,7 +54847,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -45377,7 +54858,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -45412,18 +54894,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -45431,13 +54913,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -45449,22 +54937,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -45472,13 +54960,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -45487,7 +54981,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -45495,18 +54989,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -45514,15 +55022,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -45530,14 +55038,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -45546,7 +55054,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -45555,19 +55064,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -45576,7 +55115,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -45587,20 +55126,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -45608,13 +55148,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -45626,34 +55172,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -45665,15 +55217,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -45696,7 +55248,8 @@ { "fileName": "src/AuthAdminApi.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthAdminApi.ts#L3" } ], "type": { @@ -45721,7 +55274,8 @@ { "fileName": "src/AuthClient.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthClient.ts#L3" } ], "type": { @@ -45735,7 +55289,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES", "kind": 32, "kindString": "Variable", @@ -45746,7 +55300,8 @@ { "fileName": "src/lib/types.ts", "line": 1337, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1337" } ], "type": { @@ -45781,18 +55336,15 @@ "isConst": true }, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 6, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" } ], "type": { @@ -45811,18 +55363,15 @@ "kindString": "Property", "flags": {}, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L10" } ], "type": { @@ -45835,16 +55384,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [563] } + ], + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 6, + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" + } ] } }, "defaultValue": "..." }, { - "id": 1255, + "id": 1260, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -45853,19 +55409,20 @@ { "fileName": "src/lib/errors.ts", "line": 41, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L41" } ], "signatures": [ { - "id": 1256, + "id": 1261, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1257, + "id": 1262, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -45882,7 +55439,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" } } @@ -45890,7 +55447,7 @@ ] }, { - "id": 1252, + "id": 1257, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -45899,19 +55456,20 @@ { "fileName": "src/lib/errors.ts", "line": 26, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L26" } ], "signatures": [ { - "id": 1253, + "id": 1258, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1254, + "id": 1259, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -45928,7 +55486,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -45936,7 +55494,7 @@ ] }, { - "id": 1261, + "id": 1266, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -45945,19 +55503,20 @@ { "fileName": "src/lib/errors.ts", "line": 105, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L105" } ], "signatures": [ { - "id": 1262, + "id": 1267, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1263, + "id": 1268, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -45974,7 +55533,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" } } @@ -45982,7 +55541,7 @@ ] }, { - "id": 1264, + "id": 1269, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -45991,19 +55550,20 @@ { "fileName": "src/lib/errors.ts", "line": 135, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L135" } ], "signatures": [ { - "id": 1265, + "id": 1270, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1266, + "id": 1271, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -46020,7 +55580,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" } } @@ -46028,7 +55588,7 @@ ] }, { - "id": 1258, + "id": 1263, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -46037,19 +55597,20 @@ { "fileName": "src/lib/errors.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L72" } ], "signatures": [ { - "id": 1259, + "id": 1264, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1260, + "id": 1265, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -46066,7 +55627,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" } } @@ -46074,7 +55635,7 @@ ] }, { - "id": 1267, + "id": 1272, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -46083,19 +55644,20 @@ { "fileName": "src/lib/errors.ts", "line": 157, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L157" } ], "signatures": [ { - "id": 1268, + "id": 1273, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1269, + "id": 1274, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -46112,7 +55674,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" } } @@ -46129,7 +55691,8 @@ { "fileName": "src/lib/locks.ts", "line": 59, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L59" } ], "signatures": [ @@ -46140,8 +55703,54 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring {@link\nGoTrueClient}.", - "text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClient", + "target": 78 + }, + { + "kind": "text", + "text": ".\n\nYou can turn on debugging by setting the " + }, + { + "kind": "code", + "text": "`supabase.gotrue-js.locks.debug`" + }, + { + "kind": "text", + "text": "\nlocal storage item to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " + }, + { + "kind": "code", + "text": "`request`" + }, + { + "kind": "text", + "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." + } + ] }, "typeParameter": [ { @@ -46160,7 +55769,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -46174,7 +55788,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -46188,7 +55815,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -46198,6 +55830,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 62, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L62" + } + ], "signatures": [ { "id": 555, @@ -46214,9 +55854,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46233,9 +55873,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46250,7 +55890,8 @@ { "fileName": "src/lib/locks.ts", "line": 171, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L171" } ], "signatures": [ @@ -46261,8 +55902,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.", - "text": "Use {@link #navigatorLock} in browser environments.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#navigatorLock", + "target": 0 + }, + { + "kind": "text", + "text": " in browser environments." + } + ] }, "typeParameter": [ { @@ -46281,7 +55936,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -46295,7 +55955,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -46309,7 +55982,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -46319,6 +55997,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 174, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L174" + } + ], "signatures": [ { "id": 571, @@ -46335,9 +56021,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46354,9 +56040,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46365,45 +56051,41 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [ - 1280, 1270, 1337, 1328, 1413, 1320, 1364, 1391, 1312, 1290, 1401, 1300, 1, 78, 556 + 1285, 1275, 1342, 1333, 1418, 1325, 1369, 1396, 1317, 1295, 1406, 1305, 1, 78, 556 ] }, { "title": "Interfaces", - "kind": 256, "children": [ - 724, 787, 740, 1004, 1152, 1103, 1243, 715, 800, 755, 748, 781, 728, 752, 942, 934, 950 + 724, 787, 740, 1009, 1157, 1108, 1248, 715, 800, 755, 748, 781, 728, 752, 947, 939, 955 ] }, { "title": "Type Aliases", - "kind": 4194304, "children": [ - 574, 573, 861, 1136, 1127, 1149, 1140, 1069, 1212, 1059, 1196, 1092, 1080, 1060, 1046, - 639, 612, 625, 654, 667, 1091, 1165, 954, 914, 915, 998, 988, 1007, 1021, 1008, 1028, - 993, 982, 584, 1162, 1224, 1239, 575, 1042, 1038, 1029, 1191, 1186, 1030, 1033, 953, - 682, 1179, 1172, 572, 1229, 955, 695, 808, 874, 862, 831, 844, 969, 1183, 1251, 814, - 884, 897, 1159, 704, 933, 608, 606, 932 + 574, 573, 863, 1141, 1132, 1154, 1145, 1074, 1217, 1064, 1201, 1097, 1085, 1065, 1051, + 639, 612, 625, 654, 667, 1096, 1170, 959, 919, 920, 1003, 993, 1012, 1026, 1013, 1033, + 998, 987, 584, 1167, 1229, 1244, 575, 1047, 1043, 1034, 1196, 1191, 1035, 1038, 958, + 682, 1184, 1177, 572, 1234, 960, 695, 810, 876, 864, 833, 846, 974, 1188, 1256, 816, + 886, 902, 1164, 704, 938, 608, 606, 937 ] }, { "title": "Variables", - "kind": 32, - "children": [546, 547, 1250, 561] + "children": [546, 547, 1255, 561] }, { "title": "Functions", - "kind": 64, - "children": [1255, 1252, 1261, 1264, 1258, 1267, 548, 564] + "children": [1260, 1257, 1266, 1269, 1263, 1272, 548, 564] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/index.ts#L1" } ] }, @@ -46416,7 +56098,7 @@ "originalName": "", "children": [ { - "id": 687, + "id": 683, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -46425,7 +56107,7 @@ }, "children": [ { - "id": 688, + "id": 684, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -46434,38 +56116,39 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ], "signatures": [ { - "id": 689, + "id": 685, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 690, + "id": 686, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 691, + "id": 687, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 692, + "id": 688, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -46482,7 +56165,7 @@ ], "parameters": [ { - "id": 693, + "id": 689, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -46490,14 +56173,14 @@ "type": { "type": "reflection", "declaration": { - "id": 694, + "id": 690, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 699, + "id": 695, "name": "body", "kind": 1024, "kindString": "Property", @@ -46508,7 +56191,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -46517,7 +56201,7 @@ } }, { - "id": 702, + "id": 698, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -46528,27 +56212,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 703, + "id": 699, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 704, + "id": 700, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 705, + "id": 701, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -46558,21 +56250,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 706, + "id": 702, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -46581,9 +56273,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -46592,14 +56284,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46607,7 +56299,7 @@ } }, { - "id": 697, + "id": 693, "name": "headers", "kind": 1024, "kindString": "Property", @@ -46616,18 +56308,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 707, + "id": 703, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -46638,7 +56331,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -46647,7 +56341,7 @@ } }, { - "id": 695, + "id": 691, "name": "method", "kind": 1024, "kindString": "Property", @@ -46656,7 +56350,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -46686,7 +56381,7 @@ } }, { - "id": 698, + "id": 694, "name": "schema", "kind": 1024, "kindString": "Property", @@ -46697,7 +56392,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -46706,7 +56402,7 @@ } }, { - "id": 700, + "id": 696, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -46717,7 +56413,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -46726,7 +56423,7 @@ } }, { - "id": 701, + "id": 697, "name": "signal", "kind": 1024, "kindString": "Property", @@ -46737,18 +56434,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 696, + "id": 692, "name": "url", "kind": 1024, "kindString": "Property", @@ -46757,22 +56455,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [699, 702, 697, 707, 695, 698, 700, 701, 696] + "children": [695, 698, 693, 703, 691, 694, 696, 697, 692] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -46781,21 +56487,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -46805,7 +56511,7 @@ ] }, { - "id": 712, + "id": 708, "name": "body", "kind": 1024, "kindString": "Property", @@ -46817,7 +56523,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -46826,7 +56533,7 @@ } }, { - "id": 715, + "id": 711, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -46837,27 +56544,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 716, + "id": 712, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 717, + "id": 713, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 718, + "id": 714, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -46867,21 +56582,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 719, + "id": 715, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -46890,9 +56605,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -46901,14 +56616,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -46916,7 +56631,7 @@ } }, { - "id": 710, + "id": 706, "name": "headers", "kind": 1024, "kindString": "Property", @@ -46927,18 +56642,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 720, + "id": 716, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -46949,7 +56665,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -46958,7 +56675,7 @@ } }, { - "id": 708, + "id": 704, "name": "method", "kind": 1024, "kindString": "Property", @@ -46969,7 +56686,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -46999,7 +56717,7 @@ } }, { - "id": 711, + "id": 707, "name": "schema", "kind": 1024, "kindString": "Property", @@ -47011,7 +56729,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -47020,7 +56739,7 @@ } }, { - "id": 713, + "id": 709, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -47031,7 +56750,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -47041,7 +56761,7 @@ "defaultValue": "false" }, { - "id": 714, + "id": 710, "name": "signal", "kind": 1024, "kindString": "Property", @@ -47053,18 +56773,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 709, + "id": 705, "name": "url", "kind": 1024, "kindString": "Property", @@ -47075,18 +56796,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 742, + "id": 738, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -47095,57 +56817,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 743, + "id": 739, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 744, + "id": 740, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 749, + "id": 745, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 741, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 742, "name": "merge", "kind": 1024, "kindString": "Property", @@ -47156,7 +56915,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -47168,8 +56928,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [746] + "children": [742] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -47177,14 +56944,14 @@ "default": { "type": "reflection", "declaration": { - "id": 747, + "id": 743, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 744, "name": "merge", "kind": 1024, "kindString": "Property", @@ -47193,7 +56960,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -47205,8 +56973,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [748] + "children": [744] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -47215,11 +56990,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -47229,12 +57004,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -47259,7 +57034,7 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47281,7 +57056,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -47289,17 +57064,17 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -47312,17 +57087,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -47334,12 +57109,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -47348,7 +57123,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -47358,7 +57133,7 @@ ] }, { - "id": 739, + "id": 735, "name": "returns", "kind": 2048, "kindString": "Method", @@ -47367,44 +57142,68 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 241, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L241" } ], "signatures": [ { - "id": 740, + "id": 736, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 741, + "id": 737, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -47412,12 +57211,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 741, + "id": 737, "name": "NewResult" } ], @@ -47425,7 +57224,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -47435,7 +57234,7 @@ ] }, { - "id": 723, + "id": 719, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -47444,22 +57243,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 724, + "id": 720, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 725, + "id": 721, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -47470,7 +57275,7 @@ } }, { - "id": 726, + "id": 722, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -47483,21 +57288,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -47507,7 +57312,7 @@ ] }, { - "id": 727, + "id": 723, "name": "then", "kind": 2048, "kindString": "Method", @@ -47516,19 +57321,20 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 728, + "id": 724, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 729, + "id": 725, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -47537,7 +57343,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -47546,11 +57352,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47558,11 +57364,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47571,7 +57377,7 @@ } }, { - "id": 730, + "id": 726, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -47584,7 +57390,7 @@ ], "parameters": [ { - "id": 731, + "id": 727, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -47601,21 +57407,29 @@ { "type": "reflection", "declaration": { - "id": 732, + "id": 728, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 733, + "id": 729, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 734, + "id": 730, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -47624,7 +57438,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -47633,11 +57447,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47645,11 +57459,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47663,7 +57477,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -47671,13 +57485,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -47689,7 +57503,7 @@ } }, { - "id": 735, + "id": 731, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -47706,21 +57520,29 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 732, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 737, + "id": 733, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 734, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -47736,7 +57558,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -47744,13 +57566,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -47770,20 +57592,20 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "implementationOf": { "type": "reference", @@ -47797,7 +57619,7 @@ } }, { - "id": 721, + "id": 717, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -47806,40 +57628,51 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 722, + "id": 718, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -47847,16 +57680,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { @@ -47875,49 +57708,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [688] + "children": [684] }, { "title": "Properties", - "kind": 1024, - "children": [712, 715, 710, 720, 708, 711, 713, 714, 709] + "children": [708, 711, 706, 716, 704, 707, 709, 710, 705] }, { "title": "Methods", - "kind": 2048, - "children": [742, 739, 723, 727, 721] + "children": [738, 735, 719, 723, 717] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 750, + "id": 746, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 751, + "id": 747, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 752, + "id": 748, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -47935,7 +57766,7 @@ "extendedBy": [ { "type": "reference", - "id": 534, + "id": 530, "name": "PostgrestTransformBuilder" } ], @@ -47947,7 +57778,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -47956,11 +57787,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47968,11 +57799,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -47980,9 +57811,9 @@ } } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] }, @@ -47993,7 +57824,12 @@ "kindString": "Class", "flags": {}, "comment": { - "shortText": "PostgREST client." + "summary": [ + { + "kind": "text", + "text": "PostgREST client." + } + ] }, "children": [ { @@ -48005,8 +57841,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 44, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L51" } ], "signatures": [ @@ -48017,7 +57854,12 @@ "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Creates a PostgREST client." + "summary": [ + { + "kind": "text", + "text": "Creates a PostgREST client." + } + ] }, "typeParameter": [ { @@ -48032,75 +57874,86 @@ } }, { - "id": 15, + "id": 16, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 13, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 14, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 14, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } + "fileName": "src/PostgrestClient.ts", + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [14] - } - ] + "type": { + "type": "reference", + "name": "I" + } } - } - ], - "name": "GetGenericDatabaseWithOptions" + ], + "groups": [ + { + "title": "Properties", + "children": [14] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 15, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } } } }, { - "id": 20, + "id": 17, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -48116,64 +57969,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 17, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [17] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -48187,71 +58001,32 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 19, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [19] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } }, { - "id": 23, + "id": 18, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -48266,64 +58041,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 22, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [22] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -48350,13 +58086,18 @@ ], "parameters": [ { - "id": 24, + "id": 19, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint" + "summary": [ + { + "kind": "text", + "text": "URL of the PostgREST endpoint" + } + ] }, "type": { "type": "intrinsic", @@ -48364,26 +58105,31 @@ } }, { - "id": 25, + "id": 20, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 26, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 29, + "id": 24, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -48393,31 +58139,44 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 53, - "character": 6 + "line": 60, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 30, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 31, + "id": 26, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Custom fetch\n" + "summary": [ + { + "kind": "text", + "text": "Custom fetch" + } + ] }, "parameters": [ { - "id": 32, + "id": 27, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -48427,21 +58186,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 33, + "id": 28, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -48450,9 +58209,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -48461,14 +58220,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -48476,7 +58235,7 @@ } }, { - "id": 27, + "id": 22, "name": "headers", "kind": 1024, "kindString": "Property", @@ -48484,24 +58243,30 @@ "isOptional": true }, "comment": { - "shortText": "Custom headers" + "summary": [ + { + "kind": "text", + "text": "Custom headers" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 51, - "character": 6 + "line": 58, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L58" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 28, + "id": 23, "name": "schema", "kind": 1024, "kindString": "Property", @@ -48509,18 +58274,24 @@ "isOptional": true }, "comment": { - "shortText": "Postgres schema to switch to" + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, - "character": 6 + "line": 59, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L59" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName", "dereferenced": {} } @@ -48529,8 +58300,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [29, 27, 28] + "children": [24, 22, 23] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 57, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L57" } ] } @@ -48549,17 +58327,17 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" } ], @@ -48569,7 +58347,7 @@ ] }, { - "id": 37, + "id": 32, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -48579,28 +58357,36 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 32, - "character": 2 + "line": 39, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L39" } ], "type": { "type": "reflection", "declaration": { - "id": 38, + "id": 33, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 39, + "id": 34, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 40, + "id": 35, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -48610,21 +58396,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 41, + "id": 36, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -48633,9 +58419,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -48644,14 +58430,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -48659,7 +58445,7 @@ } }, { - "id": 35, + "id": 30, "name": "headers", "kind": 1024, "kindString": "Property", @@ -48667,19 +58453,20 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 30, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L37" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 36, + "id": 31, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -48689,19 +58476,20 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 31, - "character": 2 + "line": 38, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L38" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName", "dereferenced": {} } }, { - "id": 34, + "id": 29, "name": "url", "kind": 1024, "kindString": "Property", @@ -48709,8 +58497,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2 + "line": 36, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L36" } ], "type": { @@ -48719,7 +58508,7 @@ } }, { - "id": 42, + "id": 37, "name": "from", "kind": 2048, "kindString": "Method", @@ -48727,23 +58516,41 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 61, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L68" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L72" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 80, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L80" } ], "signatures": [ { - "id": 43, + "id": 38, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 44, + "id": 39, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -48754,7 +58561,7 @@ } }, { - "id": 45, + "id": 40, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -48767,17 +58574,22 @@ ], "parameters": [ { - "id": 46, + "id": 41, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 44, + "id": 39, "name": "TableName", "dereferenced": {} } @@ -48785,46 +58597,46 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, { "type": "reference", - "id": 44, + "id": 39, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 47, + "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 48, + "id": 43, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -48833,7 +58645,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -48845,8 +58658,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [48] + "children": [43] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -48865,17 +58685,22 @@ } }, { - "id": 49, + "id": 44, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 50, + "id": 45, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -48886,7 +58711,7 @@ } }, { - "id": 51, + "id": 46, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -48899,17 +58724,22 @@ ], "parameters": [ { - "id": 52, + "id": 47, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName", "dereferenced": {} } @@ -48917,46 +58747,46 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 53, + "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 49, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -48965,7 +58795,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -48977,8 +58808,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54] + "children": [49] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -48999,7 +58837,7 @@ ] }, { - "id": 59, + "id": 54, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -49007,23 +58845,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 127, - "character": 2 + "line": 134, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L134" } ], "signatures": [ { - "id": 60, + "id": 55, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 61, + "id": 56, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -49034,7 +58878,7 @@ } }, { - "id": 62, + "id": 57, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -49047,29 +58891,39 @@ ], "parameters": [ { - "id": 63, + "id": 58, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 61, + "id": 56, "name": "FnName", "dereferenced": {} } }, { - "id": 64, + "id": 59, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -49079,33 +58933,38 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 65, + "id": 60, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 66, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 69, + "id": 64, "name": "count", "kind": 1024, "kindString": "Property", @@ -49113,13 +58972,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 137, - "character": 6 + "line": 144, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L144" } ], "type": { @@ -49141,7 +59038,7 @@ } }, { - "id": 68, + "id": 63, "name": "get", "kind": 1024, "kindString": "Property", @@ -49149,13 +59046,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 136, - "character": 6 + "line": 143, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L143" } ], "type": { @@ -49164,7 +59075,7 @@ } }, { - "id": 67, + "id": 62, "name": "head", "kind": 1024, "kindString": "Property", @@ -49172,13 +59083,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 135, - "character": 6 + "line": 142, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L142" } ], "type": { @@ -49190,8 +59123,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [69, 68, 67] + "children": [64, 63, 62] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 141, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L141" } ] } @@ -49201,16 +59141,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { @@ -49223,7 +59163,7 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, @@ -49266,9 +59206,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -49299,13 +59239,13 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, { "type": "reference", - "id": 61, + "id": 56, "name": "FnName" }, { @@ -49323,7 +59263,7 @@ ] }, { - "id": 55, + "id": 50, "name": "schema", "kind": 2048, "kindString": "Method", @@ -49331,24 +59271,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 89, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L96" } ], "signatures": [ { - "id": 56, + "id": 51, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 57, + "id": 52, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -49361,17 +59306,22 @@ ], "parameters": [ { - "id": 58, + "id": 53, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema", "dereferenced": {} } @@ -49388,12 +59338,12 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, { @@ -49402,7 +59352,7 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, "objectType": { @@ -49441,36 +59391,39 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [10] }, { "title": "Properties", - "kind": 1024, - "children": [37, 35, 36, 34] + "children": [32, 30, 31, 29] }, { "title": "Methods", - "kind": 2048, - "children": [42, 59, 55] + "children": [37, 54, 50] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 15, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L15" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 70, + "id": 65, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + "summary": [ + { + "kind": "text", + "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" + } + ] }, "default": { "type": "intrinsic", @@ -49478,88 +59431,118 @@ } }, { - "id": 73, + "id": 69, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 66, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 67, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 72, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [72] - } - ], "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 4 + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } - ] + ], + "type": { + "type": "inferred", + "name": "I", + "constraint": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + } } - } - ], - "name": "GetGenericDatabaseWithOptions" + ], + "groups": [ + { + "title": "Properties", + "children": [67] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 68, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 21, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L21" + } + ] + } } } }, { - "id": 74, + "id": 70, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" + }, + { + "kind": "code", + "text": "`\"public\"`" + }, + { + "kind": "text", + "text": ", this must be supplied manually." + } + ] }, "type": { "type": "intersection", @@ -49572,23 +59555,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -49603,23 +59584,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { @@ -49637,23 +59616,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -49661,7 +59638,7 @@ } }, { - "id": 75, + "id": 71, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -49676,27 +59653,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -49707,27 +59682,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "falseType": { @@ -49739,18 +59712,28 @@ ] }, { - "id": 753, + "id": 749, "name": "PostgrestError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, "children": [ { - "id": 754, + "id": 750, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -49759,19 +59742,20 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "signatures": [ { - "id": 755, + "id": 751, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 756, + "id": 752, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -49779,14 +59763,14 @@ "type": { "type": "reflection", "declaration": { - "id": 757, + "id": 753, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 757, "name": "code", "kind": 1024, "kindString": "Property", @@ -49795,7 +59779,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 73 + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -49804,7 +59789,7 @@ } }, { - "id": 759, + "id": 755, "name": "details", "kind": 1024, "kindString": "Property", @@ -49813,7 +59798,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -49822,7 +59808,7 @@ } }, { - "id": 760, + "id": 756, "name": "hint", "kind": 1024, "kindString": "Property", @@ -49831,7 +59817,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -49840,7 +59827,7 @@ } }, { - "id": 758, + "id": 754, "name": "message", "kind": 1024, "kindString": "Property", @@ -49849,7 +59836,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -49861,8 +59849,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ] } @@ -49871,7 +59866,7 @@ ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" }, "overwrites": { @@ -49886,7 +59881,7 @@ } }, { - "id": 764, + "id": 760, "name": "code", "kind": 1024, "kindString": "Property", @@ -49895,7 +59890,8 @@ { "fileName": "src/PostgrestError.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" } ], "type": { @@ -49904,7 +59900,7 @@ } }, { - "id": 762, + "id": 758, "name": "details", "kind": 1024, "kindString": "Property", @@ -49913,7 +59909,8 @@ { "fileName": "src/PostgrestError.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" } ], "type": { @@ -49922,7 +59919,7 @@ } }, { - "id": 763, + "id": 759, "name": "hint", "kind": 1024, "kindString": "Property", @@ -49931,7 +59928,8 @@ { "fileName": "src/PostgrestError.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } ], "type": { @@ -49943,66 +59941,73 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [754] + "children": [750] }, { "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "children": [760, 758, 759] } ], "sources": [ { "fileName": "src/PostgrestError.ts", "line": 6, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ] }, { - "id": 165, + "id": 161, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 166, + "id": 162, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" + } + ], "signatures": [ { - "id": 167, + "id": 163, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 168, + "id": 164, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 169, + "id": 165, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -50013,7 +60018,7 @@ } }, { - "id": 170, + "id": 166, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -50030,20 +60035,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 171, + "id": 167, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 172, + "id": 168, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -50054,7 +60059,7 @@ } }, { - "id": 173, + "id": 169, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -50065,7 +60070,7 @@ } }, { - "id": 174, + "id": 170, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -50078,7 +60083,7 @@ ], "parameters": [ { - "id": 175, + "id": 171, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -50086,14 +60091,14 @@ "type": { "type": "reflection", "declaration": { - "id": 176, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 181, + "id": 177, "name": "body", "kind": 1024, "kindString": "Property", @@ -50104,7 +60109,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -50113,7 +60119,7 @@ } }, { - "id": 184, + "id": 180, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -50124,27 +60130,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 186, + "id": 182, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 183, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -50154,21 +60168,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 188, + "id": 184, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -50177,9 +60191,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -50188,14 +60202,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -50203,7 +60217,7 @@ } }, { - "id": 179, + "id": 175, "name": "headers", "kind": 1024, "kindString": "Property", @@ -50212,18 +60226,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 189, + "id": 185, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -50234,7 +60249,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -50243,7 +60259,7 @@ } }, { - "id": 177, + "id": 173, "name": "method", "kind": 1024, "kindString": "Property", @@ -50252,7 +60268,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -50282,7 +60299,7 @@ } }, { - "id": 180, + "id": 176, "name": "schema", "kind": 1024, "kindString": "Property", @@ -50293,7 +60310,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -50302,7 +60320,7 @@ } }, { - "id": 182, + "id": 178, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -50313,7 +60331,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -50322,7 +60341,7 @@ } }, { - "id": 183, + "id": 179, "name": "signal", "kind": 1024, "kindString": "Property", @@ -50333,18 +60352,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 178, + "id": 174, "name": "url", "kind": 1024, "kindString": "Property", @@ -50353,22 +60373,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [181, 184, 179, 189, 177, 180, 182, 183, 178] + "children": [177, 180, 175, 185, 173, 176, 178, 179, 174] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -50377,41 +60405,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -50419,19 +60447,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 536, + "id": 532, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 535, + "id": 531, "name": "default.constructor" } }, { - "id": 492, + "id": 488, "name": "body", "kind": 1024, "kindString": "Property", @@ -50443,7 +60471,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -50452,12 +60481,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 645, + "id": 641, "name": "default.body" } }, { - "id": 495, + "id": 491, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -50468,27 +60497,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 496, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 497, + "id": 493, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 494, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -50498,21 +60535,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 499, + "id": 495, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -50521,9 +60558,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -50532,14 +60569,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -50547,12 +60584,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 648, + "id": 644, "name": "default.fetch" } }, { - "id": 490, + "id": 486, "name": "headers", "kind": 1024, "kindString": "Property", @@ -50563,23 +60600,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 643, + "id": 639, "name": "default.headers" } }, { - "id": 500, + "id": 496, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -50590,7 +60628,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -50599,12 +60638,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 653, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 488, + "id": 484, "name": "method", "kind": 1024, "kindString": "Property", @@ -50615,7 +60654,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -50645,12 +60685,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 637, "name": "default.method" } }, { - "id": 491, + "id": 487, "name": "schema", "kind": 1024, "kindString": "Property", @@ -50662,7 +60702,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -50671,12 +60712,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 644, + "id": 640, "name": "default.schema" } }, { - "id": 493, + "id": 489, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -50687,7 +60728,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -50697,12 +60739,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 646, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 494, + "id": 490, "name": "signal", "kind": 1024, "kindString": "Property", @@ -50714,23 +60756,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 647, + "id": 643, "name": "default.signal" } }, { - "id": 489, + "id": 485, "name": "url", "kind": 1024, "kindString": "Property", @@ -50741,23 +60784,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 642, + "id": 638, "name": "default.url" } }, { - "id": 457, + "id": 453, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -50766,74 +60810,85 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 195, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" } ], "signatures": [ { - "id": 458, + "id": 454, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] }, "parameters": [ { - "id": 459, + "id": 455, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] }, "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -50841,19 +60896,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 607, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 606, "name": "default.abortSignal" } }, { - "id": 301, + "id": 297, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -50862,22 +60917,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L354" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 358, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L358" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 366, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L366" } ], "signatures": [ { - "id": 302, + "id": 298, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 303, + "id": 299, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -50890,29 +60979,39 @@ ], "parameters": [ { - "id": 304, + "id": 300, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName", "dereferenced": {} } }, { - "id": 305, + "id": 301, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -50933,9 +61032,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -50946,12 +61045,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -50963,41 +61062,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -51005,23 +61104,49 @@ } }, { - "id": 306, + "id": 302, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 307, + "id": 303, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -51029,13 +61154,18 @@ } }, { - "id": 308, + "id": 304, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -51067,9 +61197,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -51077,41 +61207,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -51121,7 +61251,7 @@ ] }, { - "id": 293, + "id": 289, "name": "contains", "kind": 2048, "kindString": "Method", @@ -51130,22 +61260,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L327" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L331" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 339, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L339" } ], "signatures": [ { - "id": 294, + "id": 290, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 295, + "id": 291, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -51158,29 +61322,39 @@ ], "parameters": [ { - "id": 296, + "id": 292, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName", "dereferenced": {} } }, { - "id": 297, + "id": 293, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -51201,9 +61375,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -51214,12 +61388,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -51231,41 +61405,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -51273,23 +61447,49 @@ } }, { - "id": 298, + "id": 294, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 299, + "id": 295, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -51297,13 +61497,18 @@ } }, { - "id": 300, + "id": 296, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -51335,9 +61540,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -51345,41 +61550,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -51389,7 +61594,7 @@ ] }, { - "id": 466, + "id": 462, "name": "csv", "kind": 2048, "kindString": "Method", @@ -51398,26 +61603,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 237, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" } ], "signatures": [ { - "id": 467, + "id": 463, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -51433,19 +61652,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 616, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 619, + "id": 615, "name": "default.csv" } }, { - "id": 190, + "id": 186, "name": "eq", "kind": 2048, "kindString": "Method", @@ -51454,23 +61673,60 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L99" } ], "signatures": [ { - "id": 191, + "id": 187, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nTo check if the value of " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL, you should use " + }, + { + "kind": "code", + "text": "`.is()`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "typeParameter": [ { - "id": 192, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -51483,29 +61739,39 @@ ], "parameters": [ { - "id": 193, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName", "dereferenced": {} } }, { - "id": 194, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -51514,17 +61780,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -51545,17 +61811,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -51573,9 +61839,9 @@ "name": "ResolvedFilterValue" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, "falseType": { "type": "intrinsic", @@ -51587,41 +61853,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -51631,7 +61897,7 @@ ] }, { - "id": 470, + "id": 466, "name": "explain", "kind": 2048, "kindString": "Method", @@ -51640,42 +61906,60 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 275, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" } ], "signatures": [ { - "id": 471, + "id": 467, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." + } + ] }, "parameters": [ { - "id": 472, + "id": 468, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 473, + "id": 469, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 474, + "id": 470, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -51683,13 +61967,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 283, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { @@ -51698,7 +61996,7 @@ } }, { - "id": 477, + "id": 473, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -51706,13 +62004,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 286, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -51721,7 +62033,7 @@ } }, { - "id": 479, + "id": 475, "name": "format", "kind": 1024, "kindString": "Property", @@ -51729,13 +62041,31 @@ "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 288, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -51753,7 +62083,7 @@ } }, { - "id": 476, + "id": 472, "name": "settings", "kind": 1024, "kindString": "Property", @@ -51761,13 +62091,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 285, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" } ], "type": { @@ -51776,7 +62120,7 @@ } }, { - "id": 475, + "id": 471, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -51784,13 +62128,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 284, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { @@ -51799,7 +62165,7 @@ } }, { - "id": 478, + "id": 474, "name": "wal", "kind": 1024, "kindString": "Property", @@ -51807,13 +62173,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on WAL record generation\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { @@ -51825,8 +62205,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [474, 477, 479, 476, 475, 478] + "children": [470, 473, 475, 472, 471, 474] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" } ] } @@ -51839,11 +62226,11 @@ "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -51859,11 +62246,11 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -51880,9 +62267,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { @@ -51896,19 +62283,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 620, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 623, + "id": 619, "name": "default.explain" } }, { - "id": 396, + "id": 392, "name": "filter", "kind": 2048, "kindString": "Method", @@ -51917,23 +62304,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 581, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L581" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 586, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L586" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 600, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L600" } ], "signatures": [ { - "id": 397, + "id": 393, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 398, + "id": 394, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -51946,29 +62366,39 @@ ], "parameters": [ { - "id": 399, + "id": 395, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 398, + "id": 394, "name": "ColumnName", "dereferenced": {} } }, { - "id": 400, + "id": 396, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "union", @@ -52069,13 +62499,18 @@ } }, { - "id": 401, + "id": 397, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -52085,41 +62520,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52127,24 +62562,49 @@ } }, { - "id": 402, + "id": 398, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 403, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -52152,13 +62612,18 @@ } }, { - "id": 404, + "id": 400, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -52166,13 +62631,18 @@ } }, { - "id": 405, + "id": 401, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -52182,41 +62652,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52226,7 +62696,7 @@ ] }, { - "id": 468, + "id": 464, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -52235,26 +62705,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 245, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" } ], "signatures": [ { - "id": 469, + "id": 465, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -52269,9 +62753,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "literal", @@ -52282,19 +62766,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 618, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 621, + "id": 617, "name": "default.geojson" } }, { - "id": 200, + "id": 196, "name": "gt", "kind": 2048, "kindString": "Method", @@ -52303,22 +62787,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 132, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L132" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 133, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L133" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L140" } ], "signatures": [ { - "id": 201, + "id": 197, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 202, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -52331,40 +62849,50 @@ ], "parameters": [ { - "id": 203, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName", "dereferenced": {} } }, { - "id": 204, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -52372,41 +62900,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52414,23 +62942,49 @@ } }, { - "id": 205, + "id": 201, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 206, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -52438,13 +62992,18 @@ } }, { - "id": 207, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -52454,41 +63013,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52498,7 +63057,7 @@ ] }, { - "id": 208, + "id": 204, "name": "gte", "kind": 2048, "kindString": "Method", @@ -52507,22 +63066,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 145, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L145" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L146" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 153, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L153" } ], "signatures": [ { - "id": 209, + "id": 205, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 210, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -52535,40 +63128,50 @@ ], "parameters": [ { - "id": 211, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName", "dereferenced": {} } }, { - "id": 212, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -52576,41 +63179,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52618,23 +63221,49 @@ } }, { - "id": 213, + "id": 209, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 214, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -52642,13 +63271,18 @@ } }, { - "id": 215, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -52658,41 +63292,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52702,7 +63336,7 @@ ] }, { - "id": 256, + "id": 252, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -52711,22 +63345,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 229, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L229" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 230, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L230" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 237, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L237" } ], "signatures": [ { - "id": 257, + "id": 253, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 258, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -52739,29 +63407,39 @@ ], "parameters": [ { - "id": 259, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 258, + "id": 254, "name": "ColumnName", "dereferenced": {} } }, { - "id": 260, + "id": 256, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -52771,41 +63449,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52813,23 +63491,49 @@ } }, { - "id": 261, + "id": 257, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 262, + "id": 258, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -52837,13 +63541,18 @@ } }, { - "id": 263, + "id": 259, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -52853,41 +63562,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -52897,7 +63606,7 @@ ] }, { - "id": 264, + "id": 260, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", @@ -52906,22 +63615,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 242, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L242" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L246" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 253, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L253" } ], "signatures": [ { - "id": 265, + "id": 261, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 266, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -52934,29 +63677,39 @@ ], "parameters": [ { - "id": 267, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 266, + "id": 262, "name": "ColumnName", "dereferenced": {} } }, { - "id": 268, + "id": 264, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -52973,41 +63726,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53015,23 +63768,49 @@ } }, { - "id": 269, + "id": 265, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 270, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -53039,13 +63818,18 @@ } }, { - "id": 271, + "id": 267, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -53062,41 +63846,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53106,7 +63890,7 @@ ] }, { - "id": 272, + "id": 268, "name": "ilikeAnyOf", "kind": 2048, "kindString": "Method", @@ -53115,22 +63899,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 258, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L258" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 262, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L262" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 269, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L269" } ], "signatures": [ { - "id": 273, + "id": 269, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 274, + "id": 270, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -53143,29 +63961,39 @@ ], "parameters": [ { - "id": 275, + "id": 271, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 274, + "id": 270, "name": "ColumnName", "dereferenced": {} } }, { - "id": 276, + "id": 272, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -53182,41 +64010,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53224,23 +64052,49 @@ } }, { - "id": 277, + "id": 273, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 278, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -53248,13 +64102,18 @@ } }, { - "id": 279, + "id": 275, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -53271,41 +64130,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53315,7 +64174,7 @@ ] }, { - "id": 288, + "id": 284, "name": "in", "kind": 2048, "kindString": "Method", @@ -53324,22 +64183,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L302" } ], "signatures": [ { - "id": 289, + "id": 285, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is included in the " + }, + { + "kind": "code", + "text": "`values`" + }, + { + "kind": "text", + "text": " array." + } + ] }, "typeParameter": [ { - "id": 290, + "id": 286, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -53352,29 +64233,39 @@ ], "parameters": [ { - "id": 291, + "id": 287, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName", "dereferenced": {} } }, { - "id": 292, + "id": 288, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The values array to filter with" + } + ] }, "type": { "type": "typeOperator", @@ -53388,17 +64279,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -53419,17 +64310,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -53455,41 +64346,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53499,7 +64390,7 @@ ] }, { - "id": 280, + "id": 276, "name": "is", "kind": 2048, "kindString": "Method", @@ -53508,23 +64399,112 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 274, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L274" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 278, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L278" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 291, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L291" } ], "signatures": [ { - "id": 281, + "id": 277, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 282, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -53537,140 +64517,83 @@ ], "parameters": [ { - "id": 283, + "id": 279, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 282, + "id": 278, "name": "ColumnName", "dereferenced": {} } }, { - "id": 284, + "id": 280, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": false - } - ] - }, + "summary": [ { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": true - } - ] + "kind": "text", + "text": "The value to filter with" } ] + }, + "type": { + "type": "intrinsic", + "name": "Object" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53678,24 +64601,105 @@ } }, { - "id": 285, + "id": 281, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 286, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -53703,13 +64707,18 @@ } }, { - "id": 287, + "id": 283, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "union", @@ -53728,41 +64737,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53772,7 +64781,7 @@ ] }, { - "id": 232, + "id": 228, "name": "like", "kind": 2048, "kindString": "Method", @@ -53781,22 +64790,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 184, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L184" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 185, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L185" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 192, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L192" } ], "signatures": [ { - "id": 233, + "id": 229, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 234, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -53809,29 +64852,39 @@ ], "parameters": [ { - "id": 235, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 234, + "id": 230, "name": "ColumnName", "dereferenced": {} } }, { - "id": 236, + "id": 232, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -53841,41 +64894,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53883,23 +64936,49 @@ } }, { - "id": 237, + "id": 233, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 238, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -53907,13 +64986,18 @@ } }, { - "id": 239, + "id": 235, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -53923,41 +65007,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -53967,7 +65051,7 @@ ] }, { - "id": 240, + "id": 236, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -53976,22 +65060,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 197, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L197" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 201, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L201" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 208, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L208" } ], "signatures": [ { - "id": 241, + "id": 237, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 242, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -54004,29 +65122,39 @@ ], "parameters": [ { - "id": 243, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 242, + "id": 238, "name": "ColumnName", "dereferenced": {} } }, { - "id": 244, + "id": 240, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -54043,41 +65171,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54085,23 +65213,49 @@ } }, { - "id": 245, + "id": 241, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 246, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -54109,13 +65263,18 @@ } }, { - "id": 247, + "id": 243, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -54132,41 +65291,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54176,7 +65335,7 @@ ] }, { - "id": 248, + "id": 244, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -54185,22 +65344,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L213" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 217, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 224, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L224" } ], "signatures": [ { - "id": 249, + "id": 245, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 250, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -54213,29 +65406,39 @@ ], "parameters": [ { - "id": 251, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 250, + "id": 246, "name": "ColumnName", "dereferenced": {} } }, { - "id": 252, + "id": 248, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -54252,41 +65455,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54294,23 +65497,49 @@ } }, { - "id": 253, + "id": 249, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 254, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -54318,13 +65547,18 @@ } }, { - "id": 255, + "id": 251, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -54341,41 +65575,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54385,7 +65619,7 @@ ] }, { - "id": 442, + "id": 438, "name": "limit", "kind": 2048, "kindString": "Method", @@ -54394,28 +65628,47 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" } ], "signatures": [ { - "id": 443, + "id": 439, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 444, + "id": 440, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows to return" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] }, "type": { "type": "intrinsic", @@ -54423,26 +65676,31 @@ } }, { - "id": 445, + "id": 441, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 442, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 443, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -54450,13 +65708,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -54465,7 +65737,7 @@ } }, { - "id": 448, + "id": 444, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -54473,13 +65745,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -54491,8 +65769,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [447, 448] + "children": [443, 444] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } @@ -54502,41 +65787,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54544,19 +65829,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 596, + "id": 592, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 595, + "id": 591, "name": "default.limit" } }, { - "id": 216, + "id": 212, "name": "lt", "kind": 2048, "kindString": "Method", @@ -54565,22 +65850,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 158, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L158" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 159, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L159" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 166, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L166" } ], "signatures": [ { - "id": 217, + "id": 213, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 218, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -54593,40 +65912,50 @@ ], "parameters": [ { - "id": 219, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName", "dereferenced": {} } }, { - "id": 220, + "id": 216, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -54634,41 +65963,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54676,23 +66005,49 @@ } }, { - "id": 221, + "id": 217, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 222, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -54700,13 +66055,18 @@ } }, { - "id": 223, + "id": 219, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -54716,41 +66076,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54760,7 +66120,7 @@ ] }, { - "id": 224, + "id": 220, "name": "lte", "kind": 2048, "kindString": "Method", @@ -54769,22 +66129,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L171" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 172, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L172" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 179, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L179" } ], "signatures": [ { - "id": 225, + "id": 221, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 226, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -54797,40 +66191,50 @@ ], "parameters": [ { - "id": 227, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName", "dereferenced": {} } }, { - "id": 228, + "id": 224, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -54838,41 +66242,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54880,23 +66284,49 @@ } }, { - "id": 229, + "id": 225, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 230, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -54904,13 +66334,18 @@ } }, { - "id": 231, + "id": 227, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -54920,41 +66355,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -54964,7 +66399,7 @@ ] }, { - "id": 373, + "id": 369, "name": "match", "kind": 2048, "kindString": "Method", @@ -54973,22 +66408,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 514, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L514" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 515, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L515" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 523, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L523" } ], "signatures": [ { - "id": 374, + "id": 370, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "typeParameter": [ { - "id": 375, + "id": 371, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -55001,79 +66470,84 @@ ], "parameters": [ { - "id": 376, + "id": 372, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55081,23 +66555,49 @@ } }, { - "id": 377, + "id": 373, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "parameters": [ { - "id": 378, + "id": 374, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", @@ -55111,49 +66611,49 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55163,7 +66663,7 @@ ] }, { - "id": 485, + "id": 481, "name": "maxAffected", "kind": 2048, "kindString": "Method", @@ -55172,28 +66672,39 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], "signatures": [ { - "id": 486, + "id": 482, "name": "maxAffected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] }, "parameters": [ { - "id": 487, + "id": 483, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" + } + ] }, "type": { "type": "intrinsic", @@ -55214,7 +66725,7 @@ }, "objectType": { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" } } @@ -55229,7 +66740,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 174, + "id": 170, "name": "Method" }, "extendsType": { @@ -55251,41 +66762,41 @@ }, "trueType": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55315,19 +66826,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 639, + "id": 635, "name": "default.maxAffected" } } ], "inheritedFrom": { "type": "reference", - "id": 638, + "id": 634, "name": "default.maxAffected" } }, { - "id": 463, + "id": 459, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -55336,23 +66847,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 220, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], "signatures": [ { - "id": 464, + "id": 460, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, "typeParameter": [ { - "id": 465, + "id": 461, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -55361,7 +66893,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, "extendsType": { @@ -55384,11 +66916,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -55400,7 +66932,7 @@ }, { "type": "reference", - "id": 465, + "id": 461, "name": "ResultOne" } ] @@ -55414,19 +66946,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 613, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 612, "name": "default.maybeSingle" } }, { - "id": 195, + "id": 191, "name": "neq", "kind": 2048, "kindString": "Method", @@ -55435,22 +66967,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 120, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L120" } ], "signatures": [ { - "id": 196, + "id": 192, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is not equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 197, + "id": 193, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -55463,29 +67017,39 @@ ], "parameters": [ { - "id": 198, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName", "dereferenced": {} } }, { - "id": 199, + "id": 195, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -55494,17 +67058,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -55525,17 +67089,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -55559,41 +67123,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55603,7 +67167,7 @@ ] }, { - "id": 379, + "id": 375, "name": "not", "kind": 2048, "kindString": "Method", @@ -55612,23 +67176,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 530, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L530" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 535, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L535" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 549, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L549" } ], "signatures": [ { - "id": 380, + "id": 376, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 381, + "id": 377, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -55641,29 +67238,39 @@ ], "parameters": [ { - "id": 382, + "id": 378, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName", "dereferenced": {} } }, { - "id": 383, + "id": 379, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "reference", @@ -55671,24 +67278,29 @@ } }, { - "id": 384, + "id": 380, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -55696,41 +67308,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55738,24 +67350,49 @@ } }, { - "id": 385, + "id": 381, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 386, + "id": 382, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -55763,13 +67400,18 @@ } }, { - "id": 387, + "id": 383, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -55777,13 +67419,18 @@ } }, { - "id": 388, + "id": 384, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -55793,41 +67440,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55837,7 +67484,7 @@ ] }, { - "id": 389, + "id": 385, "name": "or", "kind": 2048, "kindString": "Method", @@ -55846,29 +67493,55 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 569, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L569" } ], "signatures": [ { - "id": 390, + "id": 386, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`filters`" + }, + { + "kind": "text", + "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " + }, + { + "kind": "code", + "text": "`.or()`" + }, + { + "kind": "text", + "text": " filter across multiple tables." + } + ] }, "parameters": [ { - "id": 391, + "id": 387, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The filters to use, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -55876,26 +67549,31 @@ } }, { - "id": 392, + "id": 388, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 390, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -55903,13 +67581,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `referencedTable` instead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`referencedTable`" + }, + { + "kind": "text", + "text": " instead" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -55918,7 +67610,7 @@ } }, { - "id": 395, + "id": 391, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -55926,13 +67618,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to filter on referenced tables\ninstead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to filter on referenced tables\ninstead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -55944,8 +67642,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [394, 395] + "children": [390, 391] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 574, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ] } @@ -55955,41 +67660,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -55999,7 +67704,7 @@ ] }, { - "id": 411, + "id": 407, "name": "order", "kind": 2048, "kindString": "Method", @@ -56008,23 +67713,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 412, + "id": 408, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "typeParameter": [ { - "id": 413, + "id": 409, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -56037,23 +67787,28 @@ ], "parameters": [ { - "id": 414, + "id": 410, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "id": 413, + "id": 409, "name": "ColumnName", "dereferenced": {} } }, { - "id": 415, + "id": 411, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -56061,19 +67816,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 416, + "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 413, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -56081,13 +67841,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -56096,7 +67870,7 @@ } }, { - "id": 418, + "id": 414, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -56104,13 +67878,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -56119,7 +67931,7 @@ } }, { - "id": 419, + "id": 415, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -56127,13 +67939,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -56145,8 +67963,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [417, 418, 419] + "children": [413, 414, 415] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ] } @@ -56155,41 +67980,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56197,29 +68022,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 561, "name": "default.order" } }, { - "id": 420, + "id": 416, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "parameters": [ { - "id": 421, + "id": 417, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "intrinsic", @@ -56227,7 +68077,7 @@ } }, { - "id": 422, + "id": 418, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -56235,19 +68085,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 419, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 420, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -56255,13 +68110,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -56270,7 +68139,7 @@ } }, { - "id": 425, + "id": 421, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -56278,13 +68147,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -56293,7 +68200,7 @@ } }, { - "id": 426, + "id": 422, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -56301,13 +68208,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -56319,8 +68232,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [424, 425, 426] + "children": [420, 421, 422] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ] } @@ -56329,41 +68249,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56371,29 +68291,45 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 569, "name": "default.order" } }, { - "id": 427, + "id": 423, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "typeParameter": [ { - "id": 428, + "id": 424, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -56406,43 +68342,37 @@ ], "parameters": [ { - "id": 429, + "id": 425, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "reference", - "id": 428, + "id": 424, "name": "ColumnName", "dereferenced": {} } }, { - "id": 430, + "id": 426, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 431, + "id": 427, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 432, + "id": 428, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -56453,7 +68383,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -56462,7 +68393,7 @@ } }, { - "id": 434, + "id": 430, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -56473,7 +68404,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -56482,7 +68414,7 @@ } }, { - "id": 433, + "id": 429, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -56493,7 +68425,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -56505,8 +68438,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [432, 434, 433] + "children": [428, 430, 429] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ] } @@ -56515,41 +68455,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56557,63 +68497,73 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 576, "name": "default.order" } }, { - "id": 435, + "id": 431, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "parameters": [ { - "id": 436, + "id": 432, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 437, + "id": 433, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 438, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 439, + "id": 435, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -56624,7 +68574,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -56633,7 +68584,7 @@ } }, { - "id": 441, + "id": 437, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -56644,7 +68595,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -56653,7 +68605,7 @@ } }, { - "id": 440, + "id": 436, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -56664,7 +68616,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -56676,8 +68629,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 441, 440] + "children": [435, 437, 436] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } @@ -56686,41 +68646,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56728,19 +68688,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 588, + "id": 584, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 560, "name": "default.order" } }, { - "id": 349, + "id": 345, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -56749,22 +68709,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 453, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L453" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 457, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L457" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 465, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L465" } ], "signatures": [ { - "id": 350, + "id": 346, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "typeParameter": [ { - "id": 351, + "id": 347, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -56777,29 +68771,39 @@ ], "parameters": [ { - "id": 352, + "id": 348, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName", "dereferenced": {} } }, { - "id": 353, + "id": 349, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -56817,12 +68821,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -56834,41 +68838,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56876,23 +68880,49 @@ } }, { - "id": 354, + "id": 350, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "parameters": [ { - "id": 355, + "id": 351, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -56900,13 +68930,18 @@ } }, { - "id": 356, + "id": 352, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -56932,41 +68967,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -56976,7 +69011,7 @@ ] }, { - "id": 519, + "id": 515, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -56985,57 +69020,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 520, + "id": 516, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 521, + "id": 517, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 526, + "id": 522, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 522, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 519, "name": "merge", "kind": 1024, "kindString": "Property", @@ -57046,7 +69118,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -57058,8 +69131,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [523] + "children": [519] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -57067,14 +69147,14 @@ "default": { "type": "reflection", "declaration": { - "id": 524, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 521, "name": "merge", "kind": 1024, "kindString": "Property", @@ -57083,7 +69163,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -57095,8 +69176,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [521] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -57105,11 +69193,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -57119,12 +69207,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -57149,7 +69237,7 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -57171,7 +69259,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -57179,17 +69267,17 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -57202,271 +69290,941 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], "name": "MergePartialResult" } - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "reference", - "id": 521, - "name": "NewResult" - } - ], - "name": "CheckMatchingArrayTypes" - } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 517, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 669, + "name": "default.overrideTypes" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 668, + "name": "default.overrideTypes" + } + }, + { + "id": 445, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 173, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" + } + ], + "signatures": [ + { + "id": 446, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] + }, + "parameters": [ + { + "id": 447, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 448, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 449, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 451, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [451, 452] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 161, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 599, + "name": "default.range" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 598, + "name": "default.range" + } + }, + { + "id": 337, + "name": "rangeAdjacent", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 438, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L438" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 439, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L439" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 448, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L448" + } + ], + "signatures": [ + { + "id": 338, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] + }, + "typeParameter": [ + { + "id": 339, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 340, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] + }, + "type": { + "type": "reference", + "id": 339, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 341, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 161, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" + } + ], + "name": "default" + } + }, + { + "id": 342, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] + }, + "parameters": [ + { + "id": 343, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 344, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 161, + "typeArguments": [ { - "type": "literal", - "value": false + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" } ], "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 673, - "name": "default.overrideTypes" } } - ], - "inheritedFrom": { - "type": "reference", - "id": 672, - "name": "default.overrideTypes" - } + ] }, { - "id": 449, - "name": "range", + "id": 305, + "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 173, - "character": 2 + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L380" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 381, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L381" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L389" } ], "signatures": [ { - "id": 450, - "name": "range", + "id": 306, + "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, + "typeParameter": [ + { + "id": 307, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "parameters": [ { - "id": 451, - "name": "from", + "id": 308, + "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { - "type": "intrinsic", - "name": "number" + "type": "reference", + "id": 307, + "name": "ColumnName", + "dereferenced": {} } }, { - "id": 452, - "name": "to", + "id": 309, + "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", - "name": "number" + "name": "string" } - }, + } + ], + "type": { + "type": "reference", + "id": 161, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" + } + ], + "name": "default" + } + }, + { + "id": 310, + "name": "rangeGt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "parameters": [ { - "id": 453, - "name": "options", + "id": 311, + "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, - "originalName": "__namedParameters", "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 455, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 179, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 456, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 179, - "character": 32 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [455, 456] - } - ] - } + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 312, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, - "defaultValue": "{}" + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 603, - "name": "default.range" } } - ], - "inheritedFrom": { - "type": "reference", - "id": 602, - "name": "default.range" - } + ] }, { - "id": 341, - "name": "rangeAdjacent", + "id": 313, + "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 438, - "character": 2 + "line": 394, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L394" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 395, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L395" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 404, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L404" } ], "signatures": [ { - "id": 342, - "name": "rangeAdjacent", + "id": 314, + "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 343, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -57479,29 +70237,39 @@ ], "parameters": [ { - "id": 344, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 343, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 345, + "id": 317, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57511,41 +70279,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -57553,23 +70321,57 @@ } }, { - "id": 346, - "name": "rangeAdjacent", + "id": 318, + "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 347, + "id": 319, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -57577,13 +70379,18 @@ } }, { - "id": 348, + "id": 320, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57593,41 +70400,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -57637,31 +70444,65 @@ ] }, { - "id": 309, - "name": "rangeGt", + "id": 321, + "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 380, - "character": 2 + "line": 409, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L409" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 410, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L410" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 418, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L418" } ], "signatures": [ { - "id": 310, - "name": "rangeGt", + "id": 322, + "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 311, + "id": 323, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -57674,29 +70515,39 @@ ], "parameters": [ { - "id": 312, + "id": 324, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 311, + "id": 323, "name": "ColumnName", "dereferenced": {} } }, { - "id": 313, + "id": 325, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57706,41 +70557,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -57748,23 +70599,49 @@ } }, { - "id": 314, - "name": "rangeGt", + "id": 326, + "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 315, + "id": 327, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -57772,13 +70649,18 @@ } }, { - "id": 316, + "id": 328, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57788,41 +70670,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -57832,31 +70714,73 @@ ] }, { - "id": 317, - "name": "rangeGte", + "id": 329, + "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 394, - "character": 2 + "line": 423, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L423" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 424, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L424" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 433, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L433" } ], "signatures": [ { - "id": 318, - "name": "rangeGte", + "id": 330, + "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 319, + "id": 331, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -57869,29 +70793,39 @@ ], "parameters": [ { - "id": 320, + "id": 332, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 319, + "id": 331, "name": "ColumnName", "dereferenced": {} } }, { - "id": 321, + "id": 333, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57901,41 +70835,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -57943,23 +70877,57 @@ } }, { - "id": 322, - "name": "rangeGte", + "id": 334, + "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 323, + "id": 335, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -57967,13 +70935,18 @@ } }, { - "id": 324, + "id": 336, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -57983,41 +70956,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -58027,344 +71000,488 @@ ] }, { - "id": 325, - "name": "rangeLt", + "id": 478, + "name": "returns", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 409, - "character": 2 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 328, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" } ], "signatures": [ { - "id": 326, - "name": "rangeLt", + "id": 479, + "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] + } + ] }, "typeParameter": [ { - "id": 327, - "name": "ColumnName", + "id": 480, + "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 328, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 327, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 329, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 165, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, - "name": "Result" + "typeArguments": [ + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 480, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 632, + "name": "default.returns" } - }, + } + ], + "inheritedFrom": { + "type": "reference", + "id": 631, + "name": "default.returns" + } + }, + { + "id": 476, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 330, - "name": "rangeLt", + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 317, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" + } + ], + "signatures": [ + { + "id": 477, + "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." - }, - "parameters": [ - { - "id": 331, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 332, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" + { + "kind": "code", + "text": "`data`" }, - "type": { - "type": "intrinsic", - "name": "string" + { + "kind": "text", + "text": " will still be returned, but the query is not committed." } - } - ], + ] + }, "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 630, + "name": "default.rollback" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "id": 629, + "name": "default.rollback" + } }, { - "id": 333, - "name": "rangeLte", + "id": 402, + "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 423, - "character": 2 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" } ], "signatures": [ { - "id": 334, - "name": "rangeLte", + "id": 403, + "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 335, - "name": "ColumnName", + "id": 404, + "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 405, + "name": "NewResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 783, + "typeArguments": [ + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 404, + "name": "Query" + }, + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + } + ], + "name": "GetResult" } } ], "parameters": [ { - "id": 336, - "name": "column", + "id": 406, + "name": "columns", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] }, "type": { "type": "reference", - "id": 335, - "name": "ColumnName", + "id": 404, + "name": "Query", "dereferenced": {} } - }, - { - "id": 337, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "type": { "type": "reference", - "id": 165, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { - "type": "reference", - "id": 171, - "name": "Result" + "type": "array", + "elementType": { + "type": "reference", + "id": 405, + "name": "NewResultOne" + } }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 556, + "name": "default.select" } - }, + } + ], + "inheritedFrom": { + "type": "reference", + "id": 555, + "name": "default.select" + } + }, + { + "id": 499, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 338, - "name": "rangeLte", + "fileName": "src/PostgrestBuilder.ts", + "line": 78, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" + } + ], + "signatures": [ + { + "id": 500, + "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 339, - "name": "column", + "id": 501, + "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 340, - "name": "range", + "id": 502, + "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -58373,742 +71490,1557 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 653, + "name": "default.setHeader" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "id": 652, + "name": "default.setHeader" + } }, { - "id": 482, - "name": "returns", + "id": 456, + "name": "single", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 328, - "character": 2 + "line": 206, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" } ], "signatures": [ { - "id": 483, - "name": "returns", + "id": 457, + "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "kind": "text", + "text": "), otherwise this\nreturns an error." } ] }, "typeParameter": [ { - "id": 484, - "name": "NewResult", + "id": 458, + "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The new result type to override with" + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 167, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } } ], "type": { "type": "reference", - "id": 534, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, - "name": "Schema" - }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "reference", - "id": 484, - "name": "NewResult" - } - ], - "name": "CheckMatchingArrayTypes" - }, - { - "type": "reference", - "id": 172, - "name": "RelationName" - }, - { - "type": "reference", - "id": 173, - "name": "Relationships" + "id": 458, + "name": "ResultOne" }, { - "type": "reference", - "id": 174, - "name": "Method" + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 636, - "name": "default.returns" + "id": 610, + "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 635, - "name": "default.returns" + "id": 609, + "name": "default.single" } }, { - "id": 480, - "name": "rollback", + "id": 353, + "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 317, - "character": 2 + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 476, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L476" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 481, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L481" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 496, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L496" } ], "signatures": [ { - "id": 481, - "name": "rollback", + "id": 354, + "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, + "typeParameter": [ + { + "id": 355, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 356, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] + }, + "type": { + "type": "reference", + "id": 355, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 357, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The query text to match with" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 358, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 360, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 479, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 361, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 479, + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [360, 361] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" + } + ] + } + } + } + ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 634, - "name": "default.rollback" } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 633, - "name": "default.rollback" - } - }, - { - "id": 406, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 29, - "character": 2 - } - ], - "signatures": [ + }, { - "id": 407, - "name": "select", + "id": 362, + "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, - "typeParameter": [ + "parameters": [ { - "id": 408, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", + "id": 363, + "name": "column", + "kind": 32768, + "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] + }, "type": { "type": "intrinsic", "name": "string" - }, - "default": { - "type": "literal", - "value": "*" } }, { - "id": 409, - "name": "NewResultOne", - "kind": 131072, - "kindString": "Type parameter", + "id": 364, + "name": "query", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "default": { - "type": "reference", - "id": 792, - "typeArguments": [ - { - "type": "reference", - "id": 169, - "name": "Schema" - }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 172, - "name": "RelationName" - }, - { - "type": "reference", - "id": 173, - "name": "Relationships" - }, - { - "type": "reference", - "id": 408, - "name": "Query" - }, + "comment": { + "summary": [ { - "type": "reference", - "id": 168, - "name": "ClientOptions" + "kind": "text", + "text": "The query text to match with" } - ], - "name": "GetResult" + ] + }, + "type": { + "type": "intrinsic", + "name": "string" } - } - ], - "parameters": [ + }, { - "id": 410, - "name": "columns", + "id": 365, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { - "type": "reference", - "id": 408, - "name": "Query", - "dereferenced": {} + "type": "reflection", + "declaration": { + "id": 366, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 367, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 484, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 368, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 484, + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [367, 368] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 484, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" + } + ] + } } } ], "type": { "type": "reference", - "id": 534, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { - "type": "array", - "elementType": { - "type": "reference", - "id": 409, - "name": "NewResultOne" - } + "type": "reference", + "id": 167, + "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 560, - "name": "default.select" } } - ], - "inheritedFrom": { - "type": "reference", - "id": 559, - "name": "default.select" - } + ] }, { "id": 503, - "name": "setHeader", + "name": "then", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 78, - "character": 2 + "line": 84, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { "id": 504, - "name": "setHeader", + "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, - "comment": { - "shortText": "Set an HTTP header for the request." - }, - "parameters": [ + "typeParameter": [ { "id": 505, - "name": "name", + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "reference", + "id": 167, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 506, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 507, + "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 508, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], + "signatures": [ + { + "id": 509, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 510, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "reference", + "id": 167, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + } + ] + } + } + ] + } + } + ] } }, { - "id": 506, - "name": "value", + "id": 511, + "name": "onrejected", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 512, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], + "signatures": [ + { + "id": 513, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 514, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 506, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 506, + "name": "TResult2" + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + } + ] + } + } + ] + } + } + ] } } ], "type": { "type": "reference", - "id": 165, "typeArguments": [ { - "type": "reference", - "id": 168, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 169, - "name": "Schema" - }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "reference", - "id": 172, - "name": "RelationName" - }, - { - "type": "reference", - "id": 173, - "name": "Relationships" - }, - { - "type": "reference", - "id": 174, - "name": "Method" + "type": "union", + "types": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + }, + { + "type": "reference", + "id": 506, + "name": "TResult2" + } + ] } ], - "name": "default" + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" }, "inheritedFrom": { "type": "reference", "id": 657, - "name": "default.setHeader" + "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "id": 656, - "name": "default.setHeader" + "name": "default.then" } }, { - "id": 460, - "name": "single", + "id": 497, + "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 2 + "fileName": "src/PostgrestBuilder.ts", + "line": 70, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 461, - "name": "single", + "id": 498, + "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "typeParameter": [ - { - "id": 462, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 171, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" } - } - ], + ] + }, "type": { - "type": "reference", - "id": 687, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 168, - "name": "ClientOptions" + "id": 161, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" + } + ], + "name": "default" }, { "type": "reference", - "id": 462, - "name": "ResultOne" - }, - { - "type": "literal", - "value": false + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 614, - "name": "default.single" + "id": 651, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 650, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [162] + }, + { + "title": "Properties", + "children": [488, 491, 486, 496, 484, 487, 489, 490, 485] + }, + { + "title": "Methods", + "children": [ + 453, 297, 289, 462, 186, 466, 392, 464, 196, 204, 252, 260, 268, 284, 276, 228, 236, + 244, 438, 212, 220, 369, 481, 459, 191, 375, 385, 407, 345, 515, 445, 337, 305, 313, + 321, 329, 478, 476, 402, 499, 456, 353, 503, 497 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 74, + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L74" + } + ], + "typeParameters": [ + { + "id": 523, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + }, + { + "id": 524, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 525, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 526, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + }, + { + "id": 527, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 528, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 529, + "name": "Method", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 530, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 165, + "name": "Schema" + }, + { + "type": "reference", + "id": 166, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "Result" + }, + { + "type": "reference", + "id": 168, + "name": "RelationName" + }, + { + "type": "reference", + "id": 169, + "name": "Relationships" + }, + { + "type": "reference", + "id": 170, + "name": "Method" } ], - "inheritedFrom": { - "type": "reference", - "id": 613, - "name": "default.single" - } - }, + "name": "default" + } + ] + }, + { + "id": 72, + "name": "PostgrestQueryBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ { - "id": 357, - "name": "textSearch", - "kind": 2048, - "kindString": "Method", + "id": 73, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 476, - "character": 2 + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L18" } ], "signatures": [ { - "id": 358, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", + "id": 74, + "name": "new PostgrestQueryBuilder", + "kind": 16384, + "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, "typeParameter": [ { - "id": 359, - "name": "ColumnName", + "id": 75, + "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 780, + "name": "ClientServerOptions" } - } - ], - "parameters": [ + }, { - "id": 360, - "name": "column", - "kind": 32768, - "kindString": "Parameter", + "id": 76, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" - }, "type": { "type": "reference", - "id": 359, - "name": "ColumnName", - "dereferenced": {} + "name": "GenericSchema" } }, { - "id": 361, - "name": "query", + "id": 77, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + }, + { + "id": 78, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 81, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 77, + "name": "Relation" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 79, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 80, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" + } + ], + "type": { + "type": "reference", + "name": "R" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [80] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "R" + }, + "falseType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "parameters": [ + { + "id": 82, + "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The query text to match with" - }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" } }, { - "id": 362, - "name": "options", + "id": 83, + "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, + "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 364, - "name": "config", + "id": 87, + "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "The text search configuration to use" - }, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 479, - "character": 16 + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 27, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L27" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 89, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 90, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 91, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } } }, { - "id": 365, - "name": "type", + "id": 85, + "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 25, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L25" + } + ], + "type": { + "type": "reference", + "name": "HeadersInit", + "qualifiedName": "HeadersInit", + "package": "typescript" + } + }, + { + "id": 86, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 479, - "character": 33 + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 26, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L26" } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] + "type": "intrinsic", + "name": "string" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [364, 365] + "children": [87, 85, 86] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 24, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L24" } ] } @@ -59117,144 +73049,339 @@ ], "type": { "type": "reference", - "id": 165, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 76, "name": "Schema" }, { "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 171, - "name": "Result" + "id": 77, + "name": "Relation" }, { "type": "reference", - "id": 172, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 81, "name": "Relationships" - }, - { - "type": "reference", - "id": 174, - "name": "Method" } ], "name": "default" } - }, + } + ] + }, + { + "id": 96, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ { - "id": 366, - "name": "textSearch", + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L16" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 97, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 98, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 99, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 100, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 93, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L13" + } + ], + "type": { + "type": "reference", + "name": "Headers", + "qualifiedName": "Headers", + "package": "typescript" + } + }, + { + "id": 94, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L14" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 15, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L15" + } + ], + "type": { + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" + } + }, + { + "id": 92, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 12, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L12" + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + }, + { + "id": 149, + "name": "delete", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 411, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L411" + } + ], + "signatures": [ + { + "id": 150, + "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, - "parameters": [ - { - "id": 367, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" + "summary": [ + { + "kind": "text", + "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 368, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The query text to match with" + { + "kind": "code", + "text": "`.select()`" }, - "type": { - "type": "intrinsic", - "name": "string" + { + "kind": "text", + "text": " after filters." } - }, + ] + }, + "parameters": [ { - "id": 369, + "id": 151, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 370, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 371, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The text search configuration to use" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 484, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "type", + "id": 153, + "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count deleted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 484, - "character": 33 + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 414, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L414" } ], "type": { @@ -59262,15 +73389,15 @@ "types": [ { "type": "literal", - "value": "plain" + "value": "exact" }, { "type": "literal", - "value": "phrase" + "value": "planned" }, { "type": "literal", - "value": "websearch" + "value": "estimated" } ] } @@ -59279,880 +73406,280 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [371, 372] + "children": [153] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 413, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L413" } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 76, "name": "Schema" }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "reference", - "id": 172, - "name": "RelationName" - }, - { - "type": "reference", - "id": 173, - "name": "Relationships" - }, - { - "type": "reference", - "id": 174, - "name": "Method" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 507, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 84, - "character": 2 - } - ], - "signatures": [ - { - "id": 508, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 509, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 780, - "typeArguments": [ - { - "type": "reference", - "id": 171, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 510, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 511, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 512, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 513, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 514, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 780, - "typeArguments": [ - { - "type": "reference", - "id": 171, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 509, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 509, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 515, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 517, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 518, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 510, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 510, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 509, - "name": "TResult1" - }, - { - "type": "reference", - "id": 510, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 661, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 660, - "name": "default.then" - } - }, - { - "id": 501, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 70, - "character": 2 - } - ], - "signatures": [ - { - "id": 502, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "id": 165, - "typeArguments": [ - { - "type": "reference", - "id": 168, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 169, - "name": "Schema" - }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "reference", - "id": 172, - "name": "RelationName" - }, - { - "type": "reference", - "id": 173, - "name": "Relationships" - }, - { - "type": "reference", - "id": 174, - "name": "Method" - } - ], - "name": "default" - }, - { - "type": "reference", - "id": 687, - "typeArguments": [ - { - "type": "reference", - "id": 168, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 171, - "name": "Result" - }, - { - "type": "literal", - "value": true - } - ], - "name": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 655, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 654, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [166] - }, - { - "title": "Properties", - "kind": 1024, - "children": [492, 495, 490, 500, 488, 491, 493, 494, 489] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 457, 301, 293, 466, 190, 470, 396, 468, 200, 208, 256, 264, 272, 288, 280, 232, 240, - 248, 442, 216, 224, 373, 485, 463, 195, 379, 389, 411, 349, 519, 449, 341, 309, 317, - 325, 333, 482, 480, 406, 503, 460, 357, 507, 501 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 74, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 527, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - } - }, - { - "id": 528, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 529, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 77, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 78, + "name": "RelationName" + }, + { + "type": "reference", + "id": 81, + "name": "Relationships" + }, + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "default" } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 530, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - }, - { - "id": 531, - "name": "RelationName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 532, - "name": "Relationships", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } + } + ] }, { - "id": 533, - "name": "Method", - "kind": 131072, - "kindString": "Type parameter", + "id": 110, + "name": "insert", + "kind": 2048, + "kindString": "Method", "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 168, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 169, - "name": "Schema" - }, - { - "type": "reference", - "id": 170, - "name": "Row" - }, - { - "type": "reference", - "id": 171, - "name": "Result" - }, + "sources": [ { - "type": "reference", - "id": 172, - "name": "RelationName" + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 116, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L116" }, { - "type": "reference", - "id": 173, - "name": "Relationships" + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 130, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L130" }, - { - "type": "reference", - "id": 174, - "name": "Method" - } - ], - "name": "default" - } - ] - }, - { - "id": 76, - "name": "PostgrestQueryBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 77, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 18, - "character": 2 + "line": 171, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L171" } ], "signatures": [ { - "id": 78, - "name": "new PostgrestQueryBuilder", - "kind": 16384, - "kindString": "Constructor signature", + "id": 111, + "name": "insert", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "typeParameter": [ - { - "id": 79, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." } - }, + ] + }, + "typeParameter": [ { - "id": 80, - "name": "Schema", + "id": 112, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 81, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ + "typeArguments": [ { - "type": "reference", - "name": "GenericTable" + "type": "intrinsic", + "name": "string" }, { - "type": "reference", - "name": "GenericView" - } - ] - } - }, - { - "id": 82, - "name": "RelationName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 85, - "name": "Relationships", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 81, - "name": "Relation" - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "Relationships", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 37 - } - ], - "type": { - "type": "reference", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [84] - } - ] + "type": "intrinsic", + "name": "unknown" } - }, - "trueType": { - "type": "reference", - "name": "R" - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } } ], "parameters": [ { - "id": 86, - "name": "url", + "id": 113, + "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] + }, "type": { "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "id": 112, + "name": "Row", + "dereferenced": {} } }, { - "id": 87, - "name": "__namedParameters", + "id": 114, + "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 88, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 91, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 93, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 94, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 95, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 89, - "name": "headers", + "id": 116, + "name": "count", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" - } - }, - { - "id": 90, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 26, - "character": 6 + "line": 119, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L119" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [91, 89, 90] + "children": [116] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 118, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L118" } ] } @@ -60161,257 +73688,150 @@ ], "type": { "type": "reference", - "id": 76, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { - "type": "reference", - "id": 81, - "name": "Relation" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 77, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" + }, + { + "type": "literal", + "value": "POST" } ], "name": "default" } - } - ] - }, - { - "id": 100, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 101, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + }, + { + "id": 117, + "name": "insert", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "signatures": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "typeParameter": [ { - "id": 102, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", + "id": 118, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "parameters": [ - { - "id": 103, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 104, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], "type": { "type": "reference", "typeArguments": [ { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } } - ] - } - } - }, - { - "id": 97, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" - } - }, - { - "id": 98, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 99, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - }, - { - "id": 96, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 153, - "name": "delete", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 411, - "character": 2 - } - ], - "signatures": [ - { - "id": 154, - "name": "delete", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" - }, + ], "parameters": [ { - "id": 155, - "name": "options", + "id": 119, + "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 118, + "name": "Row" + } + } + }, + { + "id": 120, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, - "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 156, + "id": 121, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 157, + "id": 122, "name": "count", "kind": 1024, "kindString": "Property", @@ -60419,13 +73839,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 414, - "character": 4 + "line": 133, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L133" } ], "type": { @@ -60445,32 +73903,75 @@ } ] } + }, + { + "id": 123, + "name": "defaultToNull", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L134" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [157] + "children": [122, 123] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 132, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L132" } ] } - }, - "defaultValue": "{}" + } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -60481,7 +73982,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -60491,17 +73992,17 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "literal", - "value": "DELETE" + "value": "POST" } ], "name": "default" @@ -60510,93 +74011,156 @@ ] }, { - "id": 114, - "name": "insert", + "id": 101, + "name": "select", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 116, - "character": 2 + "line": 57, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L57" } ], "signatures": [ { - "id": 115, - "name": "insert", + "id": 102, + "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT query on the table or view." + } + ] }, "typeParameter": [ { - "id": 116, - "name": "Row", + "id": 103, + "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 104, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { "type": "reference", + "id": 783, "typeArguments": [ { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 76, + "name": "Schema" }, { - "type": "intrinsic", - "name": "unknown" + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 77, + "name": "Relation" + } + }, + { + "type": "reference", + "id": 78, + "name": "RelationName" + }, + { + "type": "reference", + "id": 81, + "name": "Relationships" + }, + { + "type": "reference", + "id": 103, + "name": "Query" + }, + { + "type": "reference", + "id": 75, + "name": "ClientOptions" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "GetResult" } } ], "parameters": [ { - "id": 117, - "name": "values", + "id": 105, + "name": "columns", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " + }, + { + "kind": "code", + "text": "`customName:columnName`" + } + ] }, "type": { "type": "reference", - "id": 116, - "name": "Row", + "id": 103, + "name": "Query", "dereferenced": {} } }, { - "id": 118, + "id": 106, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 119, + "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 120, + "id": 109, "name": "count", "kind": 1024, "kindString": "Property", @@ -60604,13 +74168,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows in the table or view.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 119, - "character": 6 + "line": 74, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L74" } ], "type": { @@ -60630,31 +74232,84 @@ } ] } + }, + { + "id": 108, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 73, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L73" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [120] + "children": [109, 108] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 72, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L72" } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -60665,45 +74320,78 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, { - "type": "literal", - "value": null + "type": "array", + "elementType": { + "type": "reference", + "id": 104, + "name": "ResultOne" + } }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "literal", - "value": "POST" + "value": "GET" } ], "name": "default" } - }, + } + ] + }, + { + "id": 142, + "name": "update", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 121, - "name": "insert", + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 361, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L361" + } + ], + "signatures": [ + { + "id": 143, + "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": " after filters." + } + ] }, "typeParameter": [ { - "id": 122, + "id": 144, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -60720,53 +74408,60 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 123, + "id": 145, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to update with" + } + ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 122, - "name": "Row" - } + "type": "reference", + "id": 144, + "name": "Row", + "dereferenced": {} } }, { - "id": 124, + "id": 146, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 125, + "id": 147, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 126, + "id": 148, "name": "count", "kind": 1024, "kindString": "Property", @@ -60774,13 +74469,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count updated rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 133, - "character": 6 + "line": 366, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L366" } ], "type": { @@ -60800,54 +74533,39 @@ } ] } - }, - { - "id": 127, - "name": "defaultToNull", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. Only applies for bulk\ninserts.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 134, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [126, 127] + "children": [148] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 365, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L365" } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -60858,7 +74576,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -60868,17 +74586,17 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "literal", - "value": "POST" + "value": "PATCH" } ], "name": "default" @@ -60887,136 +74605,168 @@ ] }, { - "id": 105, - "name": "select", + "id": 124, + "name": "upsert", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 57, - "character": 2 + "line": 217, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 233, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L233" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 288, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L288" } ], "signatures": [ { - "id": 106, - "name": "select", + "id": 125, + "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT query on the table or view." + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 107, - "name": "Query", + "id": 126, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 108, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { "type": "reference", - "id": 792, "typeArguments": [ { - "type": "reference", - "id": 80, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 81, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 82, - "name": "RelationName" - }, - { - "type": "reference", - "id": 85, - "name": "Relationships" - }, - { - "type": "reference", - "id": 107, - "name": "Query" + "type": "intrinsic", + "name": "string" }, { - "type": "reference", - "id": 79, - "name": "ClientOptions" + "type": "intrinsic", + "name": "unknown" } ], - "name": "GetResult" + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } } ], "parameters": [ { - "id": 109, - "name": "columns", + "id": 127, + "name": "values", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { "type": "reference", - "id": 107, - "name": "Query", + "id": 126, + "name": "Row", "dereferenced": {} } }, { - "id": 110, + "id": 128, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, - "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 111, + "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 113, + "id": 132, "name": "count", "kind": 1024, "kindString": "Property", @@ -61024,13 +74774,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 74, - "character": 6 + "line": 222, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L222" } ], "type": { @@ -61052,53 +74840,118 @@ } }, { - "id": 112, - "name": "head", + "id": 131, + "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 73, - "character": 6 + "line": 221, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L221" } ], "type": { "type": "intrinsic", "name": "boolean" } + }, + { + "id": 130, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns are equal." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 220, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L220" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [113, 112] + "children": [132, 131, 130] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 219, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L219" } ] } - }, - "defaultValue": "{}" + } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -61109,65 +74962,97 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, { - "type": "array", - "elementType": { - "type": "reference", - "id": 108, - "name": "ResultOne" - } + "type": "literal", + "value": null }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "literal", - "value": "GET" + "value": "POST" } ], "name": "default" } - } - ] - }, - { - "id": 146, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 361, - "character": 2 - } - ], - "signatures": [ + }, { - "id": 147, - "name": "update", + "id": 133, + "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 148, + "id": 134, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -61184,109 +75069,293 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 149, + "id": 135, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update with\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { - "type": "reference", - "id": 148, - "name": "Row", - "dereferenced": {} + "type": "array", + "elementType": { + "type": "reference", + "id": 134, + "name": "Row" + } } }, { - "id": 150, + "id": 136, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, - "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, - "name": "count", + "id": 140, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 238, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L238" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 141, + "name": "defaultToNull", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates: false`" + }, + { + "kind": "text", + "text": ". This also only applies when doing bulk upserts." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 239, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L239" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 139, + "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 366, - "character": 6 + "line": 237, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L237" } ], "type": { - "type": "union", - "types": [ + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 138, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "type": "literal", - "value": "exact" + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" }, { - "type": "literal", - "value": "planned" + "kind": "code", + "text": "`onConflict`" }, { - "type": "literal", - "value": "estimated" + "kind": "text", + "text": " columns are equal." } ] + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 236, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L236" + } + ], + "type": { + "type": "intrinsic", + "name": "string" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152] + "children": [140, 141, 139, 138] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 235, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L235" } ] } - }, - "defaultValue": "{}" + } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -61297,7 +75366,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -61307,51 +75376,226 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "literal", - "value": "PATCH" + "value": "POST" } ], "name": "default" } } ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [73] }, { - "id": 128, - "name": "upsert", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "children": [96, 93, 94, 95, 92] + }, + { + "title": "Methods", + "children": [149, 110, 101, 142, 124] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 5, + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L5" + } + ], + "typeParameters": [ + { + "id": 154, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + }, + { + "id": 155, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 156, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + }, + { + "id": 157, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 160, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 77, + "name": "Relation" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 158, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 159, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" + } + ], + "type": { + "type": "inferred", + "name": "R" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [159] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "R" + }, + "falseType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ] + }, + { + "id": 530, + "name": "PostgrestTransformBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 531, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 217, - "character": 2 + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ], "signatures": [ { - "id": 129, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", + "id": 532, + "name": "new PostgrestTransformBuilder", + "kind": 16384, + "kindString": "Constructor signature", "flags": {}, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, "typeParameter": [ { - "id": 130, + "id": 533, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + }, + { + "id": 534, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 535, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -61368,65 +75612,241 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } - } - ], - "parameters": [ + }, { - "id": 131, - "name": "values", - "kind": 32768, - "kindString": "Parameter", + "id": 536, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + }, + { + "id": 537, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "reference", - "id": 130, - "name": "Row", - "dereferenced": {} + "default": { + "type": "intrinsic", + "name": "unknown" } }, { - "id": 132, - "name": "options", + "id": 538, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 539, + "name": "Method", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 540, + "name": "builder", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters\n" - }, + "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, - "name": "count", + "id": 546, + "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 40, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 549, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, "sources": [ { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 222, - "character": 6 + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 550, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 551, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 552, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 553, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 544, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 38, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" + } + ], + "type": { + "type": "reference", + "name": "HeadersInit", + "qualifiedName": "HeadersInit", + "package": "typescript" + } + }, + { + "id": 554, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 44, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 542, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 36, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -61434,35 +75854,62 @@ "types": [ { "type": "literal", - "value": "exact" + "value": "GET" }, { "type": "literal", - "value": "planned" + "value": "HEAD" }, { "type": "literal", - "value": "estimated" + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" } ] } }, { - "id": 135, - "name": "ignoreDuplicates", + "id": 545, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 39, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 547, + "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, "sources": [ { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 221, - "character": 6 + "fileName": "src/PostgrestBuilder.ts", + "line": 41, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -61471,34 +75918,62 @@ } }, { - "id": 134, - "name": "onConflict", + "id": 548, + "name": "signal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" - }, "sources": [ { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 220, - "character": 6 + "fileName": "src/PostgrestBuilder.ts", + "line": 42, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" + } + }, + { + "id": 543, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 37, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [136, 135, 134] + "children": [546, 549, 544, 554, 542, 545, 547, 548, 543] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -61507,709 +75982,687 @@ ], "type": { "type": "reference", - "id": 165, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 534, "name": "Schema" }, { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 81, - "name": "Relation" - } + "type": "reference", + "id": 535, + "name": "Row" }, { - "type": "literal", - "value": null + "type": "reference", + "id": 536, + "name": "Result" }, { "type": "reference", - "id": 82, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 538, "name": "Relationships" }, { - "type": "literal", - "value": "POST" + "type": "reference", + "id": 539, + "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 685, + "name": "default.constructor" } - }, + } + ], + "inheritedFrom": { + "type": "reference", + "id": 684, + "name": "default.constructor" + } + }, + { + "id": 641, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ { - "id": 137, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", + "fileName": "src/PostgrestBuilder.ts", + "line": 29, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "id": 708, + "name": "default.body" + } + }, + { + "id": 644, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 32, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 645, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ + "sources": [ { - "id": 138, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], + "signatures": [ + { + "id": 646, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, + "parameters": [ + { + "id": 647, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestInfo", + "qualifiedName": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 648, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "RequestInit", + "qualifiedName": "RequestInit", + "package": "typescript" + } + } + ], "type": { "type": "reference", "typeArguments": [ { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "name": "Response", + "qualifiedName": "Response", + "package": "typescript" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } } - ], - "parameters": [ - { - "id": 139, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 138, - "name": "Row" - } - } - }, - { - "id": 140, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 238, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 145, - "name": "defaultToNull", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`. This also only applies when doing bulk upserts.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 239, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 143, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 237, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 142, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 236, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [144, 145, 143, 142] - } - ] - } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 711, + "name": "default.fetch" + } + }, + { + "id": 639, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 27, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" + } + ], + "type": { + "type": "reference", + "name": "Headers", + "qualifiedName": "Headers", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "id": 706, + "name": "default.headers" + } + }, + { + "id": 649, + "name": "isMaybeSingle", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 33, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 716, + "name": "default.isMaybeSingle" + } + }, + { + "id": 637, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 25, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 704, + "name": "default.method" + } + }, + { + "id": 640, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 28, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 707, + "name": "default.schema" + } + }, + { + "id": 642, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 30, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 709, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 643, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 31, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" + } + ], + "type": { + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "id": 710, + "name": "default.signal" + } + }, + { + "id": 638, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 26, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "id": 705, + "name": "default.url" + } + }, + { + "id": 606, + "name": "abortSignal", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 195, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" + } + ], + "signatures": [ + { + "id": 607, + "name": "abortSignal", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] + }, + "parameters": [ + { + "id": 608, + "name": "signal", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] + }, + "type": { + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 534, "name": "Schema" }, { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 81, - "name": "Relation" - } + "type": "reference", + "id": 535, + "name": "Row" }, { - "type": "literal", - "value": null + "type": "reference", + "id": 536, + "name": "Result" }, { "type": "reference", - "id": 82, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 538, "name": "Relationships" }, { - "type": "literal", - "value": "POST" + "type": "reference", + "id": 539, + "name": "Method" } ], "name": "default" } } ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [77] - }, - { - "title": "Properties", - "kind": 1024, - "children": [100, 97, 98, 99, 96] }, { - "title": "Methods", + "id": 615, + "name": "csv", "kind": 2048, - "children": [153, 114, 105, 146, 128] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 5, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 158, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - } - }, - { - "id": 159, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 160, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", + "kindString": "Method", "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 237, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" + } + ], + "signatures": [ + { + "id": 616, + "name": "csv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, - { + "type": { "type": "reference", - "name": "GenericView" - } - ] - } - }, - { - "id": 161, - "name": "RelationName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 164, - "name": "Relationships", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 81, - "name": "Relation" - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 162, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ + "id": 683, + "typeArguments": [ { - "id": 163, - "name": "Relationships", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 37 - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, { - "title": "Properties", - "kind": 1024, - "children": [163] - } - ], - "sources": [ + "type": "intrinsic", + "name": "string" + }, { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 35 + "type": "literal", + "value": false } - ] + ], + "name": "default" } - }, - "trueType": { - "type": "reference", - "name": "R" - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" } - } - } - ] - }, - { - "id": 534, - "name": "PostgrestTransformBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ + ] + }, { - "id": 535, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + "id": 619, + "name": "explain", + "kind": 2048, + "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 275, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" + } + ], "signatures": [ { - "id": 536, - "name": "new PostgrestTransformBuilder", - "kind": 16384, - "kindString": "Constructor signature", + "id": 620, + "name": "explain", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "typeParameter": [ - { - "id": 537, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - } - }, - { - "id": 538, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 539, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 540, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - }, - { - "id": 541, - "name": "RelationName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 542, - "name": "Relationships", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 543, - "name": "Method", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." } - } - ], + ] + }, "parameters": [ { - "id": 544, - "name": "builder", + "id": 621, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 553, - "name": "fetch", + "id": 623, + "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 554, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 555, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 556, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 557, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 548, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 38, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 283, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { - "type": "reference", - "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "type": "intrinsic", + "name": "boolean" } }, { - "id": 558, - "name": "isMaybeSingle", + "id": 626, + "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 44, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 286, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -62218,16 +76671,39 @@ } }, { - "id": 546, - "name": "method", + "id": 628, + "name": "format", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 36, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 288, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -62235,694 +76711,1199 @@ "types": [ { "type": "literal", - "value": "GET" + "value": "text" }, { "type": "literal", - "value": "HEAD" - }, + "value": "json" + } + ] + } + }, + { + "id": 625, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "type": "literal", - "value": "POST" + "kind": "text", + "text": "If " }, { - "type": "literal", - "value": "PATCH" + "kind": "code", + "text": "`true`" }, { - "type": "literal", - "value": "DELETE" + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" } ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 285, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" } }, { - "id": 549, - "name": "schema", + "id": 624, + "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 39, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 284, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } }, { - "id": 551, - "name": "shouldThrowOnError", + "id": 627, + "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 41, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 287, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { "type": "intrinsic", "name": "boolean" } - }, + } + ], + "groups": [ { - "id": 552, - "name": "signal", + "title": "Properties", + "children": [623, 626, 628, 625, 624, 627] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + ] + } + } + ] + }, + { + "id": 617, + "name": "geojson", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 245, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" + } + ], + "signatures": [ + { + "id": 618, + "name": "geojson", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] + }, + "type": { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + } + ] + }, + { + "id": 591, + "name": "limit", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" + } + ], + "signatures": [ + { + "id": 592, + "name": "limit", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "parameters": [ + { + "id": 593, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 594, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 596, + "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 42, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "type": "intrinsic", + "name": "string" } }, { - "id": 547, - "name": "url", + "id": 597, + "name": "referencedTable", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] + }, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 37, - "character": 4 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "type": "intrinsic", + "name": "string" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [550, 553, 548, 558, 546, 549, 551, 552, 547] + "children": [596, 597] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 689, - "name": "default.constructor" } } - ], - "inheritedFrom": { - "type": "reference", - "id": 688, - "name": "default.constructor" - } + ] }, { - "id": 645, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, + "id": 634, + "name": "maxAffected", + "kind": 2048, + "kindString": "Method", + "flags": {}, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 29, - "character": 12 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 354, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 712, - "name": "default.body" - } - }, - { - "id": 648, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ + "signatures": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 635, + "name": "maxAffected", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "signatures": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] + }, + "parameters": [ { - "id": 650, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 651, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] + "id": 636, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" } - }, + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ { - "id": 652, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "PostgrestVersion" }, - "type": { + "objectType": { "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "id": 533, + "name": "ClientOptions" } } ], - "type": { + "name": "MaxAffectedEnabled" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 539, + "name": "Method" + }, + "extendsType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "RPC" + } + ] + }, + "trueType": { "type": "reference", + "id": 530, "typeArguments": [ { "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 534, + "name": "Schema" + }, + { + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "name": "default" + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "maxAffected method only available on update or delete" + } + ], + "name": "InvalidMethodError" } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "maxAffected method only available on postgrest 13+" + } + ], + "name": "InvalidMethodError" } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 715, - "name": "default.fetch" - } - }, - { - "id": 643, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 27, - "character": 12 + } } - ], - "type": { - "type": "reference", - "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" - }, - "inheritedFrom": { - "type": "reference", - "id": 710, - "name": "default.headers" - } + ] }, { - "id": 653, - "name": "isMaybeSingle", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, + "id": 612, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, "sources": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 33, - "character": 12 + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 220, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 720, - "name": "default.isMaybeSingle" - } - }, - { - "id": 641, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ + "signatures": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 25, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" + "id": 613, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, - { - "type": "literal", - "value": "DELETE" + "typeParameter": [ + { + "id": 614, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 536, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 461, + "name": "ResultOne" + } + ] + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 708, - "name": "default.method" - } - }, - { - "id": 644, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 711, - "name": "default.schema" - } - }, - { - "id": 646, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 30, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 713, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 647, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 31, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - }, - "inheritedFrom": { - "type": "reference", - "id": 714, - "name": "default.signal" - } - }, - { - "id": 642, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 26, - "character": 12 } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - }, - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "default.url" - } + ] }, { - "id": 610, - "name": "abortSignal", + "id": 560, + "name": "order", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 195, - "character": 2 + "line": 70, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 611, - "name": "abortSignal", + "id": 561, + "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, + "typeParameter": [ + { + "id": 562, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "parameters": [ { - "id": 612, - "name": "signal", + "id": 563, + "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "id": 409, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 564, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 565, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 566, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 567, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 568, + "name": "referencedTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [566, 567, 568] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" + } + ] + } } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], "name": "default" } - } - ] - }, - { - "id": 619, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 237, - "character": 2 - } - ], - "signatures": [ + }, { - "id": 620, - "name": "csv", + "id": 569, + "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." - }, - "type": { - "type": "reference", - "id": 687, - "typeArguments": [ + "summary": [ { - "type": "reference", - "id": 537, - "name": "ClientOptions" + "kind": "text", + "text": "Order the query result by " }, { - "type": "intrinsic", - "name": "string" + "kind": "code", + "text": "`column`" }, { - "type": "literal", - "value": false + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." } - ], - "name": "default" - } - } - ] - }, - { - "id": 623, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 275, - "character": 2 - } - ], - "signatures": [ - { - "id": 624, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + ] }, "parameters": [ { - "id": 625, - "name": "options", + "id": 570, + "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 571, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, - "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 626, + "id": 572, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 627, - "name": "analyze", + "id": 573, + "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 283, - "character": 4 + "line": 76, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -62931,21 +77912,59 @@ } }, { - "id": 630, - "name": "buffers", + "id": 574, + "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 286, - "character": 4 + "line": 76, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -62954,53 +77973,186 @@ } }, { - "id": 632, - "name": "format", + "id": 575, + "name": "referencedTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 288, - "character": 4 + "line": 76, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] + "type": "intrinsic", + "name": "string" } - }, + } + ], + "groups": [ { - "id": 629, - "name": "settings", + "title": "Properties", + "children": [573, 574, 575] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 530, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 534, + "name": "Schema" + }, + { + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" + } + ], + "name": "default" + } + }, + { + "id": 576, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 577, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 578, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 424, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 579, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 580, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 581, + "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" - }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 285, - "character": 4 + "line": 83, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -63009,44 +78161,40 @@ } }, { - "id": 628, - "name": "verbose", + "id": 583, + "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" - }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 284, - "character": 4 + "line": 83, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { "type": "intrinsic", - "name": "boolean" + "name": "undefined" } }, { - "id": 631, - "name": "wal", + "id": 582, + "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "If `true`, include information on WAL record generation\n" - }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 287, - "character": 4 + "line": 83, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -63058,209 +78206,160 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [627, 630, 632, 629, 628, 631] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 687, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "default" - }, - { - "type": "reference", - "id": 687, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "children": [581, 583, 582] } - }, - { - "type": "literal", - "value": false - } - ], - "name": "default" - } - ] - } - } - ] - }, - { - "id": 621, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 245, - "character": 2 - } - ], - "signatures": [ - { - "id": 622, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." - }, + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" + } + ] + } + } + } + ], "type": { "type": "reference", - "id": 687, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "id": 534, + "name": "Schema" }, { - "type": "literal", - "value": false + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" } ], "name": "default" } - } - ] - }, - { - "id": 595, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, - "character": 2 - } - ], - "signatures": [ + }, { - "id": 596, - "name": "limit", + "id": 584, + "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] + } + ] }, "parameters": [ { - "id": 597, - "name": "count", + "id": 585, + "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The maximum number of rows to return" - }, "type": { "type": "intrinsic", - "name": "number" + "name": "string" } }, { - "id": 598, + "id": 586, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" + "flags": { + "isOptional": true }, - "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 599, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, - "name": "foreignTable", + "id": 588, + "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 590, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 151, - "character": 9 + "line": 90, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -63269,78 +78368,82 @@ } }, { - "id": 601, - "name": "referencedTable", + "id": 589, + "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 151, - "character": 32 + "line": 90, + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [600, 601] + "children": [588, 590, 589] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } - }, - "defaultValue": "{}" + } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -63350,237 +78453,318 @@ ] }, { - "id": 638, - "name": "maxAffected", + "id": 668, + "name": "overrideTypes", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 354, - "character": 2 + "fileName": "src/PostgrestBuilder.ts", + "line": 276, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 639, - "name": "maxAffected", + "id": 669, + "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - }, - "parameters": [ - { - "id": 640, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "id": 537, - "name": "ClientOptions" - } - } - ], - "name": "MaxAffectedEnabled" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 543, - "name": "Method" + { + "kind": "code", + "text": "`data`" }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ { - "type": "literal", - "value": "RPC" + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] }, - "trueType": { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, + { + "tag": "@returns", + "content": [ { - "type": "reference", - "id": 543, - "name": "Method" + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" } - ], - "name": "default" - }, - "falseType": { - "type": "reference", - "typeArguments": [ + ] + } + ] + }, + "typeParameter": [ + { + "id": 670, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "maxAffected method only available on update or delete" + "kind": "text", + "text": "The new type to cast the response data to" } - ], - "name": "InvalidMethodError" + ] } }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError" - } - } - } - ] - }, - { - "id": 616, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 220, - "character": 2 - } - ], - "signatures": [ - { - "id": 617, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "typeParameter": [ { - "id": 618, - "name": "ResultOne", + "id": 675, + "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 540, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" - }, - "falseType": { - "type": "intrinsic", - "name": "never" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 671, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 672, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [672] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" + } + ] + } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 673, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 674, + "name": "merge", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" + } + ], + "type": { + "type": "literal", + "value": true + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [674] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" + } + ] } } } ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { - "type": "union", - "types": [ - { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 517, + "name": "NewResult" + }, + { + "type": "literal", + "value": false + }, + { + "type": "literal", + "value": false + } + ], + "name": "IsValidResultOverride" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + } + ], + "name": "ContainsNull" + }, + "extendsType": { "type": "literal", - "value": null + "value": true }, - { + "trueType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 517, + "name": "NewResult" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + } + ], + "name": "NonNullable", + "qualifiedName": "NonNullable", + "package": "typescript" + }, + { + "type": "reference", + "id": 522, + "name": "Options" + } + ], + "name": "MergePartialResult" + } + ] + }, + "falseType": { "type": "reference", - "id": 465, - "name": "ResultOne" + "typeArguments": [ + { + "type": "reference", + "id": 517, + "name": "NewResult" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 522, + "name": "Options" + } + ], + "name": "MergePartialResult" } - ] + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 517, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + } }, { "type": "literal", @@ -63588,132 +78772,191 @@ } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 739, + "name": "default.overrideTypes" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "id": 738, + "name": "default.overrideTypes" + } }, { - "id": 564, - "name": "order", + "id": 598, + "name": "range", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 70, - "character": 2 + "line": 173, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" } ], "signatures": [ { - "id": 565, - "name": "order", + "id": 599, + "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] }, - "typeParameter": [ + "parameters": [ { - "id": 566, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", + "id": 600, + "name": "from", + "kind": 32768, + "kindString": "Parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] + }, "type": { "type": "intrinsic", - "name": "string" + "name": "number" } - } - ], - "parameters": [ + }, { - "id": 567, - "name": "column", + "id": 601, + "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] }, "type": { - "type": "reference", - "id": 413, - "name": "ColumnName", - "dereferenced": {} + "type": "intrinsic", + "name": "number" } }, { - "id": 568, + "id": 602, "name": "options", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 570, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 72, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 571, - "name": "nullsFirst", + "id": 604, + "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 72, - "character": 37 + "line": 179, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { "type": "intrinsic", - "name": "boolean" + "name": "string" } }, { - "id": 572, + "id": 605, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -63721,1966 +78964,2542 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 72, - "character": 59 + "line": 179, + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { "type": "intrinsic", - "name": "undefined" + "name": "string" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [570, 571, 572] + "children": [604, 605] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], "name": "default" } - }, + } + ] + }, + { + "id": 631, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 573, - "name": "order", + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 328, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" + } + ], + "signatures": [ + { + "id": 632, + "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] + } + ] }, - "parameters": [ + "typeParameter": [ { - "id": 574, - "name": "column", - "kind": 32768, - "kindString": "Parameter", + "id": 633, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 530, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" }, - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reference", + "id": 534, + "name": "Schema" + }, + { + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 480, + "name": "NewResult" + } + ], + "name": "CheckMatchingArrayTypes" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" } - }, - { - "id": 575, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true + ], + "name": "default" + }, + "overwrites": { + "type": "reference", + "id": 736, + "name": "default.returns" + } + } + ], + "overwrites": { + "type": "reference", + "id": 735, + "name": "default.returns" + } + }, + { + "id": 629, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 317, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" + } + ], + "signatures": [ + { + "id": 630, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" }, - "comment": { - "shortText": "Named parameters" + { + "kind": "code", + "text": "`data`" }, - "type": { - "type": "reflection", - "declaration": { - "id": 576, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 577, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 76, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 578, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 76, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 579, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a referenced table by\nits columns" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 76, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [577, 578, 579] - } - ] - } + { + "kind": "text", + "text": " will still be returned, but the query is not committed." + } + ] + }, + "type": { + "type": "reference", + "id": 530, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 534, + "name": "Schema" + }, + { + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 555, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 29, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" + } + ], + "signatures": [ + { + "id": 556, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "typeParameter": [ + { + "id": 557, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 558, + "name": "NewResultOne", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 783, + "typeArguments": [ + { + "type": "reference", + "id": 534, + "name": "Schema" + }, + { + "type": "reference", + "id": 535, + "name": "Row" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 404, + "name": "Query" + }, + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 559, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] + }, + "type": { + "type": "reference", + "id": 404, + "name": "Query", + "dereferenced": {} } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { - "type": "reference", - "id": 540, - "name": "Result" + "type": "array", + "elementType": { + "type": "reference", + "id": 405, + "name": "NewResultOne" + } }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], "name": "default" } - }, + } + ] + }, + { + "id": 652, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 580, - "name": "order", + "fileName": "src/PostgrestBuilder.ts", + "line": 78, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" + } + ], + "signatures": [ + { + "id": 653, + "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "kind": "text", + "text": "Set an HTTP header for the request." } ] }, - "typeParameter": [ - { - "id": 581, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], "parameters": [ { - "id": 582, - "name": "column", + "id": 654, + "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { - "type": "reference", - "id": 428, - "name": "ColumnName", - "dereferenced": {} + "type": "intrinsic", + "name": "string" } }, { - "id": 583, - "name": "options", + "id": 655, + "name": "value", "kind": 32768, "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, + "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 584, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 585, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 83, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 587, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 83, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 586, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 83, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [585, 587, 586] - } - ] - } + "type": "intrinsic", + "name": "string" } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 720, + "name": "default.setHeader" } - }, + } + ], + "inheritedFrom": { + "type": "reference", + "id": 719, + "name": "default.setHeader" + } + }, + { + "id": 609, + "name": "single", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ { - "id": 588, - "name": "order", + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 206, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" + } + ], + "signatures": [ + { + "id": 610, + "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "kind": "text", + "text": "), otherwise this\nreturns an error." } ] }, - "parameters": [ + "typeParameter": [ { - "id": 589, - "name": "column", - "kind": 32768, - "kindString": "Parameter", + "id": 611, + "name": "ResultOne", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 536, + "name": "Result" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "ResultOne" + } + }, + "trueType": { + "type": "reference", + "name": "ResultOne" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + ], + "type": { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" }, - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reference", + "id": 458, + "name": "ResultOne" + }, + { + "type": "literal", + "value": false + } + ], + "name": "default" + } + } + ] + }, + { + "id": 656, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" + } + ], + "signatures": [ + { + "id": 657, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 658, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" } }, { - "id": 590, - "name": "options", + "id": 659, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 660, + "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { - "type": "reflection", - "declaration": { - "id": 591, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 592, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 661, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 90, - "character": 16 + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" } ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 594, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, + "signatures": [ + { + "id": 662, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 663, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "reference", + "id": 536, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 664, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 665, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 90, - "character": 59 + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 593, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ + "signatures": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 90, - "character": 37 + "id": 666, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 667, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 506, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 506, + "name": "TResult2" + } + ], + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + } + ] + } } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [592, 594, 593] + ] } - ] - } + } + ] } } ], "type": { "type": "reference", - "id": 534, "typeArguments": [ { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 543, - "name": "Method" + "type": "union", + "types": [ + { + "type": "reference", + "id": 505, + "name": "TResult1" + }, + { + "type": "reference", + "id": 506, + "name": "TResult2" + } + ] } ], - "name": "default" + "name": "PromiseLike", + "qualifiedName": "PromiseLike", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "id": 724, + "name": "default.then" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "id": 723, + "name": "default.then" + } }, { - "id": 672, - "name": "overrideTypes", + "id": 650, + "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 276, - "character": 2 + "line": 70, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 673, - "name": "overrideTypes", + "id": 651, + "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" } ] }, - "typeParameter": [ - { - "id": 674, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new type to cast the response data to" - } - }, - { - "id": 679, - "name": "Options", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 676, - "name": "merge", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 278, - "character": 22 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [676] - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 678, - "name": "merge", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 278, - "character": 44 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [678] - } - ] - } - } - } - ], "type": { - "type": "reference", - "id": 687, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 521, - "name": "NewResult" - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { + "id": 530, + "typeArguments": [ + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - } - ], - "name": "ContainsNull" + "id": 533, + "name": "ClientOptions" }, - "extendsType": { - "type": "literal", - "value": true + { + "type": "reference", + "id": 534, + "name": "Schema" }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 521, - "name": "NewResult" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" - }, - { - "type": "reference", - "id": 526, - "name": "Options" - } - ], - "name": "MergePartialResult" - } - ] + { + "type": "reference", + "id": 535, + "name": "Row" }, - "falseType": { + { "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 521, - "name": "NewResult" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 526, - "name": "Options" - } - ], - "name": "MergePartialResult" + "id": 536, + "name": "Result" + }, + { + "type": "reference", + "id": 537, + "name": "RelationName" + }, + { + "type": "reference", + "id": 538, + "name": "Relationships" + }, + { + "type": "reference", + "id": 539, + "name": "Method" } - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 521, - "name": "NewResult" - } - ], - "name": "CheckMatchingArrayTypes" - } + ], + "name": "default" }, { - "type": "literal", - "value": false + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 743, - "name": "default.overrideTypes" + "id": 718, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 717, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [531] + }, + { + "title": "Properties", + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] + }, + { + "title": "Methods", + "children": [ + 606, 615, 619, 617, 591, 634, 612, 560, 668, 598, 631, 629, 555, 652, 609, 656, 650 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 11, + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L11" + } + ], + "typeParameters": [ + { + "id": 676, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + }, + { + "id": 677, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 678, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" } + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" + } + }, + { + "id": 679, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + }, + { + "id": 680, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 681, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 682, + "name": "Method", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 683, + "typeArguments": [ + { + "type": "reference", + "id": 533, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 536, + "name": "Result" + } + ], + "name": "default" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 161, + "name": "PostgrestFilterBuilder" + } + ] + }, + { + "id": 763, + "name": "PostgrestResponseFailure", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 766, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L24" } ], - "inheritedFrom": { - "type": "reference", - "id": 742, - "name": "default.overrideTypes" + "type": { + "type": "literal", + "value": null } }, { - "id": 602, - "name": "range", - "kind": 2048, - "kindString": "Method", + "id": 765, + "name": "data", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 173, - "character": 2 + "fileName": "src/types.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L23" } ], - "signatures": [ + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 764, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 603, - "name": "range", - "kind": 4096, - "kindString": "Call signature", + "fileName": "src/types.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L22" + } + ], + "type": { + "type": "reference", + "id": 749, + "name": "default", + "dereferenced": { + "id": 749, + "name": "PostgrestError", + "kind": 128, + "kindString": "Class", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, - "parameters": [ + "children": [ { - "id": 604, - "name": "from", - "kind": 32768, - "kindString": "Parameter", + "id": 750, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "signatures": [ + { + "id": 751, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 752, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 753, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 757, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 755, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 756, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 754, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 749, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 760, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" + } + ], "type": { "type": "intrinsic", - "name": "number" + "name": "string" } }, { - "id": 605, - "name": "to", - "kind": 32768, - "kindString": "Parameter", + "id": 758, + "name": "details", + "kind": 1024, + "kindString": "Property", "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" + } + ], "type": { "type": "intrinsic", - "name": "number" + "name": "string" } }, { - "id": 606, - "name": "options", - "kind": 32768, - "kindString": "Parameter", + "id": 759, + "name": "hint", + "kind": 1024, + "kindString": "Property", "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 607, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 608, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 179, - "character": 9 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 609, - "name": "referencedTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 179, - "character": 32 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [608, 609] - } - ] + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } - }, - "defaultValue": "{}" + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 543, - "name": "Method" - } - ], - "name": "default" - } + "groups": [ + { + "title": "Constructors", + "children": [750] + }, + { + "title": "Properties", + "children": [760, 758, 759] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "Error", + "qualifiedName": "Error", + "package": "typescript" + } + ] } - ] + } }, { - "id": 635, - "name": "returns", - "kind": 2048, - "kindString": "Method", + "id": 767, + "name": "status", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 328, - "character": 2 + "fileName": "src/types.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], - "signatures": [ + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } + }, + { + "id": 768, + "name": "statusText", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 636, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ - { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" - } - ] - }, - "typeParameter": [ - { - "id": 637, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new result type to override with" - } - } - ], - "type": { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 484, - "name": "NewResult" - } - ], - "name": "CheckMatchingArrayTypes" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 543, - "name": "Method" - } - ], - "name": "default" + "fileName": "src/types.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [766, 765, 764, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 21, + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L21" + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "PostgrestResponseBase" + } + ] + }, + { + "id": 769, + "name": "PostgrestResponseSuccess", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 772, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L19" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "overwrites": { - "type": "reference", - "id": 740, - "name": "default.returns" + { + "type": "intrinsic", + "name": "number" } + ] + } + }, + { + "id": 771, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L18" } ], - "overwrites": { + "type": { "type": "reference", - "id": 739, - "name": "default.returns" + "id": 775, + "name": "T", + "dereferenced": {} } }, { - "id": 633, - "name": "rollback", - "kind": 2048, - "kindString": "Method", + "id": 770, + "name": "error", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 317, - "character": 2 + "fileName": "src/types.ts", + "line": 17, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L17" } ], - "signatures": [ + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 773, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 634, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" - }, - "type": { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 543, - "name": "Method" - } - ], - "name": "default" - } + "fileName": "src/types.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } - ] + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } }, { - "id": 559, - "name": "select", - "kind": 2048, - "kindString": "Method", + "id": 774, + "name": "statusText", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 29, - "character": 2 + "fileName": "src/types.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], - "signatures": [ + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [772, 771, 770, 773, 774] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 16, + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L16" + } + ], + "typeParameters": [ + { + "id": 775, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "PostgrestResponseBase" + } + ] + }, + { + "id": 780, + "name": "PostgrestClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 74, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 781, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "id": 560, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "id": 782, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true }, - "typeParameter": [ - { - "id": 561, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 562, - "name": "NewResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 792, - "typeArguments": [ - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 408, - "name": "Query" - }, - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ + "sources": [ { - "id": 563, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 408, - "name": "Query", - "dereferenced": {} - } + "fileName": "src/types.ts", + "line": 75, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L75" } ], "type": { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 409, - "name": "NewResultOne" - } - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, - { - "type": "reference", - "id": 543, - "name": "Method" - } - ], - "name": "default" + "type": "intrinsic", + "name": "string" } } - ] - }, - { - "id": 656, - "name": "setHeader", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ + ], + "groups": [ { - "fileName": "src/PostgrestBuilder.ts", - "line": 78, - "character": 2 + "title": "Properties", + "children": [782] } ], - "signatures": [ + "sources": [ { - "id": 657, - "name": "setHeader", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Set an HTTP header for the request." - }, - "parameters": [ - { - "id": 658, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 659, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { + "fileName": "src/types.ts", + "line": 74, + "character": 34, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" + } + ] + } + } + }, + { + "id": 778, + "name": "PostgrestMaybeSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 31, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L31" + } + ], + "typeParameters": [ + { + "id": 779, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "union", + "types": [ + { "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" - }, - { - "type": "reference", - "id": 539, - "name": "Row" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "reference", - "id": 541, - "name": "RelationName" - }, - { - "type": "reference", - "id": 542, - "name": "Relationships" - }, + "id": 779, + "name": "T" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 761, + "name": "PostgrestResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 32, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L32" + } + ], + "typeParameters": [ + { + "id": 762, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 776, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 762, + "name": "T" + } + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 776, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 30, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L30" + } + ], + "typeParameters": [ + { + "id": 777, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 769, + "name": "PostgrestResponseSuccess", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 772, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "type": "reference", - "id": 543, - "name": "Method" + "fileName": "src/types.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L19" } ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 724, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 723, - "name": "default.setHeader" - } - }, - { - "id": 613, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 2 - } - ], - "signatures": [ - { - "id": 614, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "typeParameter": [ - { - "id": 615, - "name": "ResultOne", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 540, - "name": "Result" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "ResultOne" - } - }, - "trueType": { - "type": "reference", - "name": "ResultOne" + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "falseType": { + { "type": "intrinsic", - "name": "never" + "name": "number" } + ] + } + }, + { + "id": 771, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L18" } + ], + "type": { + "type": "reference", + "id": 775, + "name": "T", + "dereferenced": {} } - ], - "type": { - "type": "reference", - "id": 687, - "typeArguments": [ + }, + { + "id": 770, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, + "fileName": "src/types.ts", + "line": 17, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L17" + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 773, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "type": "reference", - "id": 462, - "name": "ResultOne" - }, + "fileName": "src/types.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } + }, + { + "id": 774, + "name": "statusText", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "type": "literal", - "value": false + "fileName": "src/types.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], - "name": "default" + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } } - } - ] - }, - { - "id": 660, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 84, - "character": 2 - } - ], - "signatures": [ - { - "id": 661, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 662, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 780, - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + ], + "groups": [ + { + "title": "Properties", + "children": [772, 771, 770, 773, 774] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 16, + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L16" + } + ], + "typeParameters": [ + { + "id": 775, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "PostgrestResponseBase" + } + ] + }, + { + "id": 763, + "name": "PostgrestResponseFailure", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 766, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L24" } - }, - { - "id": 663, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 765, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L23" } + ], + "type": { + "type": "literal", + "value": null } - ], - "parameters": [ - { - "id": 664, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, + }, + { + "id": 764, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L22" + } + ], + "type": { + "type": "reference", + "id": 749, + "name": "default", + "dereferenced": { + "id": 749, + "name": "PostgrestError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] + }, + "children": [ { - "type": "reflection", - "declaration": { - "id": 665, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 666, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 667, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 780, - "typeArguments": [ + "id": 750, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "signatures": [ + { + "id": 751, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 752, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 753, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "type": "reference", - "id": 540, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 509, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ + "id": 757, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, { - "type": "reference", - "id": 509, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 668, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 670, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 671, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 510, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ + "id": 755, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 756, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 754, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ { - "type": "reference", - "id": 510, - "name": "TResult2" + "title": "Properties", + "children": [757, 755, 756, 754] } ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" + } + ] } - ] + } } + ], + "type": { + "type": "reference", + "id": 749, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" } - ] + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 509, - "name": "TResult1" - }, - { - "type": "reference", - "id": 510, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 728, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 727, - "name": "default.then" - } - }, - { - "id": 654, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 70, - "character": 2 - } - ], - "signatures": [ - { - "id": 655, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "id": 534, - "typeArguments": [ - { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 538, - "name": "Schema" }, { - "type": "reference", - "id": 539, - "name": "Row" + "id": 760, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "type": "reference", - "id": 540, - "name": "Result" + "id": 758, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "type": "reference", - "id": 541, - "name": "RelationName" - }, + "id": 759, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ { - "type": "reference", - "id": 542, - "name": "Relationships" + "title": "Constructors", + "children": [750] }, { - "type": "reference", - "id": 543, - "name": "Method" + "title": "Properties", + "children": [760, 758, 759] } ], - "name": "default" - }, - { - "type": "reference", - "id": 687, - "typeArguments": [ + "sources": [ { - "type": "reference", - "id": 537, - "name": "ClientOptions" - }, + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" + } + ], + "extendedTypes": [ { "type": "reference", - "id": 540, - "name": "Result" - }, - { - "type": "literal", - "value": true + "name": "Error", + "qualifiedName": "Error", + "package": "typescript" } - ], - "name": "default" + ] } - ] + } }, - "inheritedFrom": { + { + "id": 767, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.status" + } + }, + { + "id": 768, + "name": "statusText", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "name": "PostgrestResponseBase.statusText" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [766, 765, 764, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 21, + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L21" + } + ], + "extendedTypes": [ + { "type": "reference", - "id": 722, - "name": "default.throwOnError" + "name": "PostgrestResponseBase" } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 721, - "name": "default.throwOnError" + ] } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [535] - }, - { - "title": "Properties", - "kind": 1024, - "children": [645, 648, 643, 653, 641, 644, 646, 647, 642] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 610, 619, 623, 621, 595, 638, 616, 564, 672, 602, 635, 633, 559, 656, 613, 660, 654 - ] - } - ], + ] + } + }, + { + "id": 783, + "name": "UnstableGetResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Main entry point for constructing the result type of a PostgREST query." + } + ] + }, "sources": [ { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 11, - "character": 21 + "fileName": "src/select-query-parser/result.ts", + "line": 37, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/select-query-parser/result.ts#L37" } ], - "typeParameter": [ - { - "id": 680, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - } - }, + "typeParameters": [ { - "id": 681, + "id": 784, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Database schema." + } + ] + }, "type": { "type": "reference", "name": "GenericSchema" } }, { - "id": 682, + "id": 785, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of a row in the current table." + } + ] + }, "type": { "type": "reference", "typeArguments": [ @@ -65693,2530 +81512,3015 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 683, - "name": "Result", + "id": 786, + "name": "RelationName", "kind": 131072, "kindString": "Type parameter", - "flags": {} + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the current table or view." + } + ] + } }, { - "id": 684, - "name": "RelationName", + "id": 787, + "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Relationships of the current table." + } + ] } }, { - "id": 685, - "name": "Relationships", + "id": 788, + "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "default": { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The select query string literal to parse." + } + ] + }, + "type": { "type": "intrinsic", - "name": "unknown" + "name": "string" } }, { - "id": 686, - "name": "Method", + "id": 789, + "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" + "type": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" } } ], - "extendedTypes": [ - { + "type": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 687, "typeArguments": [ { "type": "reference", - "id": 537, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 540, - "name": "Result" - } - ], - "name": "default" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 165, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 767, - "name": "PostgrestResponseFailure", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 770, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 24, - "character": 2 + "id": 784, + "name": "Schema" } ], - "type": { - "type": "literal", - "value": null - } + "name": "IsAny" }, - { - "id": 769, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } + "extendsType": { + "type": "literal", + "value": true }, - { - "id": 768, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 22, - "character": 2 + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 788, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 786, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodesWithoutSchema" + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" } - ], - "type": { + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 753, - "name": "default", - "dereferenced": { - "id": 753, - "name": "PostgrestError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "id": 787, + "name": "Relationships" + }, + "extendsType": { + "type": "literal", + "value": null + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 788, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" }, - "children": [ + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 786, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "id": 786, + "name": "RelationName" + }, + "falseType": { + "type": "literal", + "value": "rpc_call" + } + }, + { + "type": "reference", + "id": 785, + "name": "Row" + } + ], + "name": "RPCCallNodes" + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "reference", + "id": 785, + "name": "Row" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ { - "id": 754, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 2 + "type": "reference", + "id": 788, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 786, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 787, + "name": "Relationships" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "GenericRelationship" } - ], - "signatures": [ - { - "id": 755, - "name": "new PostgrestError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 756, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 761, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 73 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 759, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 760, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 758, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 25 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] - } - ] - } - } - } - ], - "type": { + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { "type": "reference", - "id": 753, - "name": "default" + "id": 789, + "name": "ClientOptions" }, - "overwrites": { + { "type": "reference", - "name": "Error.constructor" + "id": 784, + "name": "Schema" + }, + { + "type": "reference", + "id": 785, + "name": "Row" + }, + { + "type": "reference", + "id": 786, + "name": "RelationName" + }, + { + "type": "reference", + "id": 787, + "name": "Relationships" + }, + { + "type": "reference", + "name": "ParsedQuery" } - } - ], - "overwrites": { + ], + "name": "ProcessNodes" + }, + "falseType": { "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 764, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + "typeArguments": [ + { + "type": "literal", + "value": "Invalid Relationships cannot infer result type" + } + ], + "name": "SelectQueryError" } }, - { - "id": 762, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ + "falseType": { + "type": "reference", + "typeArguments": [ { - "fileName": "src/PostgrestError.ts", - "line": 7, - "character": 2 + "type": "literal", + "value": "Invalid RelationName cannot infer result type" } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + }, + { + "id": 1, + "name": "default", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 7, + "name": "PostgrestBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "id": 763, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 8, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/index.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L22" } ], - "groups": [ + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 683, + "name": "default" + } + } + }, + { + "id": 3, + "name": "PostgrestClient", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "title": "Constructors", - "kind": 512, - "children": [754] - }, + "fileName": "src/index.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L18" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 9, + "name": "default" + } + } + }, + { + "id": 8, + "name": "PostgrestError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "fileName": "src/index.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L23" } ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 749, + "name": "default" + } + } + }, + { + "id": 5, + "name": "PostgrestFilterBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { - "fileName": "src/PostgrestError.ts", - "line": 6, - "character": 21 + "fileName": "src/index.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L20" } ], - "extendedTypes": [ + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 161, + "name": "default" + } + } + }, + { + "id": 4, + "name": "PostgrestQueryBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ { + "fileName": "src/index.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L19" + } + ], + "type": { + "type": "query", + "queryType": { "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "id": 72, + "name": "default" } - ] - } - } - }, - { - "id": 771, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ + } + }, + { + "id": 6, + "name": "PostgrestTransformBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L21" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 530, + "name": "default" + } + } + } + ], + "groups": [ { - "fileName": "src/types.ts", - "line": 13, - "character": 2 + "title": "Properties", + "children": [7, 3, 8, 5, 4, 6] } ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 772, - "name": "statusText", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { - "fileName": "src/types.ts", - "line": 14, - "character": 2 + "fileName": "src/index.ts", + "line": 17, + "character": 15, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [770, 769, 768, 771, 772] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "PostgrestResponseBase" + ] } - ] + } + } + ], + "groups": [ + { + "title": "Classes", + "children": [683, 9, 749, 161, 72, 530] }, { - "id": 773, - "name": "PostgrestResponseSuccess", - "kind": 256, - "kindString": "Interface", + "title": "Interfaces", + "children": [763, 769] + }, + { + "title": "Type Aliases", + "children": [780, 778, 761, 776, 783] + }, + { + "title": "Variables", + "children": [1] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 2, + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L2" + } + ] + }, + { + "id": 0, + "name": "@supabase/realtime-js", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 671, + "name": "REALTIME_LISTEN_TYPES", + "variant": "declaration", + "kind": 8, "flags": {}, "children": [ { - "id": 776, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 775, - "name": "data", - "kind": 1024, - "kindString": "Property", + "id": 672, + "name": "BROADCAST", + "variant": "declaration", + "kind": 16, "flags": {}, "sources": [ { - "fileName": "src/types.ts", - "line": 18, - "character": 2 + "fileName": "src/RealtimeChannel.ts", + "line": 102, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L102" } ], "type": { - "type": "reference", - "id": 779, - "name": "T", - "dereferenced": {} + "type": "literal", + "value": "broadcast" } }, { - "id": 774, - "name": "error", - "kind": 1024, - "kindString": "Property", + "id": 674, + "name": "POSTGRES_CHANGES", + "variant": "declaration", + "kind": 16, "flags": {}, "sources": [ { - "fileName": "src/types.ts", - "line": 17, - "character": 2 + "fileName": "src/RealtimeChannel.ts", + "line": 104, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L104" } ], "type": { "type": "literal", - "value": null + "value": "postgres_changes" } }, { - "id": 777, - "name": "status", - "kind": 1024, - "kindString": "Property", + "id": 673, + "name": "PRESENCE", + "variant": "declaration", + "kind": 16, "flags": {}, "sources": [ { - "fileName": "src/types.ts", - "line": 13, - "character": 2 + "fileName": "src/RealtimeChannel.ts", + "line": 103, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L103" } ], "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" + "type": "literal", + "value": "presence" } }, { - "id": 778, - "name": "statusText", - "kind": 1024, - "kindString": "Property", + "id": 675, + "name": "SYSTEM", + "variant": "declaration", + "kind": 16, "flags": {}, "sources": [ { - "fileName": "src/types.ts", - "line": 14, - "character": 2 + "fileName": "src/RealtimeChannel.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L105" } ], "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" + "type": "literal", + "value": "system" } } ], "groups": [ { - "title": "Properties", - "kind": 1024, - "children": [776, 775, 774, 777, 778] + "title": "Enumeration Members", + "children": [672, 674, 673, 675] } ], "sources": [ { - "fileName": "src/types.ts", - "line": 16, - "character": 17 - } - ], - "typeParameter": [ - { - "id": 779, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "PostgrestResponseBase" + "fileName": "src/RealtimeChannel.ts", + "line": 101, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L101" } ] }, { - "id": 784, - "name": "ClientServerOptions", - "kind": 4194304, - "kindString": "Type alias", + "id": 676, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "variant": "declaration", + "kind": 8, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 74, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 785, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 677, + "name": "ALL", + "variant": "declaration", + "kind": 16, "flags": {}, - "children": [ - { - "id": 786, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 75, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786] - } - ], "sources": [ { - "fileName": "src/types.ts", - "line": 74, - "character": 34 + "fileName": "src/RealtimeChannel.ts", + "line": 95, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L95" } - ] - } - } - }, - { - "id": 787, - "name": "GetGenericDatabaseWithOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 85, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 788, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + ], + "type": { + "type": "literal", + "value": "*" + } }, { - "id": 791, - "name": "Opts", - "kind": 131072, - "kindString": "Type parameter", + "id": 680, + "name": "DELETE", + "variant": "declaration", + "kind": 16, "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "default": { - "type": "reflection", - "declaration": { - "id": 789, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 790, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [790] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 37 - } - ] - } - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ + "sources": [ { - "type": "reference", - "id": 788, - "name": "Database" + "fileName": "src/RealtimeChannel.ts", + "line": 98, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L98" } ], - "name": "IsAny" - }, - "extendsType": { - "type": "literal", - "value": true + "type": { + "type": "literal", + "value": "DELETE" + } }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, + { + "id": 678, + "name": "INSERT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ { - "type": "reference", - "id": 791, - "name": "Opts" + "fileName": "src/RealtimeChannel.ts", + "line": 96, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L96" } ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - } - ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" - } - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" + "type": { + "type": "literal", + "value": "INSERT" } - } - } - }, - { - "id": 782, - "name": "PostgrestMaybeSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ + }, { - "fileName": "src/types.ts", - "line": 31, - "character": 12 + "id": 679, + "name": "UPDATE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 97, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L97" + } + ], + "type": { + "type": "literal", + "value": "UPDATE" + } } ], - "typeParameter": [ + "groups": [ { - "id": 783, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "title": "Enumeration Members", + "children": [677, 680, 678, 679] } ], - "type": { - "type": "reference", - "id": 780, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 783, - "name": "T" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse" - } + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 94, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L94" + } + ] }, { - "id": 765, - "name": "PostgrestResponse", - "kind": 4194304, - "kindString": "Type alias", + "id": 681, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "variant": "declaration", + "kind": 8, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 32, - "character": 12 + "id": 683, + "name": "JOIN", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 37, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L37" + } + ], + "type": { + "type": "literal", + "value": "join" + } + }, + { + "id": 684, + "name": "LEAVE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 38, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L38" + } + ], + "type": { + "type": "literal", + "value": "leave" + } + }, + { + "id": 682, + "name": "SYNC", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 36, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L36" + } + ], + "type": { + "type": "literal", + "value": "sync" + } } ], - "typeParameter": [ + "groups": [ { - "id": 766, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "title": "Enumeration Members", + "children": [683, 684, 682] } ], - "type": { - "type": "reference", - "id": 780, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 766, - "name": "T" - } - } - ], - "name": "PostgrestSingleResponse" - } + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 35, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L35" + } + ] }, { - "id": 780, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", + "id": 685, + "name": "REALTIME_SUBSCRIBE_STATES", + "variant": "declaration", + "kind": 8, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 30, - "character": 12 + "id": 689, + "name": "CHANNEL_ERROR", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L112" + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + } + }, + { + "id": 688, + "name": "CLOSED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 111, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L111" + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + } + }, + { + "id": 686, + "name": "SUBSCRIBED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 109, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L109" + } + ], + "type": { + "type": "literal", + "value": "SUBSCRIBED" + } + }, + { + "id": 687, + "name": "TIMED_OUT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L110" + } + ], + "type": { + "type": "literal", + "value": "TIMED_OUT" + } } ], - "typeParameter": [ + "groups": [ { - "id": 781, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "title": "Enumeration Members", + "children": [689, 688, 686, 687] } ], - "type": { - "type": "union", - "types": [ + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 108, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L108" + } + ] + }, + { + "id": 59, + "name": "RealtimeChannel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ { - "id": 773, - "name": "PostgrestResponseSuccess", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 776, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 775, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 779, - "name": "T", - "dereferenced": {} - } - }, - { - "id": 774, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null + "kind": "text", + "text": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + } + ] + }, + "children": [ + { + "id": 70, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 151, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" + } + ], + "signatures": [ + { + "id": 71, + "name": "RealtimeChannel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 151, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" } - }, - { - "id": 777, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 13, - "character": 2 + ], + "parameters": [ + { + "id": 72, + "name": "topic", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" } - ], - "type": { - "type": "intrinsic", - "name": "number" }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 778, - "name": "statusText", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + { + "id": 73, + "name": "params", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 358, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" + { + "id": 74, + "name": "socket", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [776, 775, 774, 777, 778] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 16, - "character": 17 - } - ], - "typeParameter": [ - { - "id": 779, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { + ], + "type": { "type": "reference", - "name": "PostgrestResponseBase" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } - ] - }, - { - "id": 767, - "name": "PostgrestResponseFailure", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 770, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 769, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": null + } + ] + }, + { + "id": 75, + "name": "bindings", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 132, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 76, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 132, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" } - }, - { - "id": 768, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 753, - "name": "default", - "dereferenced": { - "id": 753, - "name": "PostgrestError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "children": [ - { - "id": 754, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", + ], + "indexSignatures": [ + { + "id": 77, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 133, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" + } + ], + "parameters": [ + { + "id": 78, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 79, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 2 - } - ], - "signatures": [ + "id": 85, + "name": "callback", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 136, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L136" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, { - "id": 755, - "name": "new PostgrestError", - "kind": 16384, - "kindString": "Constructor signature", + "id": 81, + "name": "filter", + "variant": "declaration", + "kind": 1024, "flags": {}, - "parameters": [ + "sources": [ { - "id": 756, - "name": "context", - "kind": 32768, - "kindString": "Parameter", + "fileName": "src/RealtimeChannel.ts", + "line": 135, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 82, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 135, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" + } + ], + "indexSignatures": [ + { + "id": 83, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, - "children": [ - { - "id": 761, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 73 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 759, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "sources": [ { - "id": 760, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "fileName": "src/RealtimeChannel.ts", + "line": 135, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" + } + ], + "parameters": [ { - "id": 758, - "name": "message", - "kind": 1024, - "kindString": "Property", + "id": 84, + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 11, - "character": 25 - } - ], "type": { "type": "intrinsic", "name": "string" } } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] - } - ] + "type": { + "type": "intrinsic", + "name": "any" + } } - } + ] + } + } + }, + { + "id": 86, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 137, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L137" } ], "type": { - "type": "reference", - "id": 753, - "name": "default" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" + "type": "intrinsic", + "name": "string" } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 764, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ + }, { - "fileName": "src/PostgrestError.ts", - "line": 9, - "character": 2 + "id": 80, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L134" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 762, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ + "groups": [ { - "fileName": "src/PostgrestError.ts", - "line": 7, - "character": 2 + "title": "Properties", + "children": [85, 81, 86, 80] } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 763, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { - "fileName": "src/PostgrestError.ts", - "line": 8, - "character": 2 + "fileName": "src/RealtimeChannel.ts", + "line": 133, + "character": 19, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [754] - }, - { - "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] - } - ], - "sources": [ - { - "fileName": "src/PostgrestError.ts", - "line": 6, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + ] } - ] - } - } - }, - { - "id": 771, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 772, - "name": "statusText", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 14, - "character": 2 + } } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "name": "PostgrestResponseBase.statusText" } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [770, 769, 768, 771, 772] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 21, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "PostgrestResponseBase" - } - ] + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 94, + "name": "broadcastEndpointURL", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 147, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L147" + } + ], + "type": { + "type": "intrinsic", + "name": "string" } - ] - } - }, - { - "id": 792, - "name": "UnstableGetResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Main entry point for constructing the result type of a PostgREST query." - }, - "sources": [ + }, + { + "id": 89, + "name": "joinedOnce", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 142, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L142" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 90, + "name": "joinPush", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 143, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L143" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + { + "id": 98, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 154, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L154" + } + ], + "type": { + "type": "reference", + "target": 358, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." + }, + { + "id": 93, + "name": "presence", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L146" + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, { - "fileName": "src/select-query-parser/result.ts", - "line": 37, - "character": 12 - } - ], - "typeParameter": [ + "id": 96, + "name": "private", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 149, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { - "id": 793, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", + "id": 92, + "name": "pushBuffer", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "shortText": "Database schema." + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L145" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/push.ts", + "qualifiedName": "default" + }, + "name": "Push", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } }, + "defaultValue": "[]" + }, + { + "id": 91, + "name": "rejoinTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L144" + } + ], "type": { "type": "reference", - "name": "GenericSchema" + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 794, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The type of a row in the current table." + "id": 99, + "name": "socket", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 155, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L155" + } + ], "type": { "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 795, - "name": "RelationName", - "kind": 131072, - "kindString": "Type parameter", + "id": 88, + "name": "state", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "shortText": "The name of the current table or view." - } + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 141, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L141" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CHANNEL_STATES" + }, + "name": "CHANNEL_STATES", + "package": "@supabase/realtime-js" + }, + "defaultValue": "CHANNEL_STATES.closed" }, { - "id": 796, - "name": "Relationships", - "kind": 131072, - "kindString": "Type parameter", + "id": 95, + "name": "subTopic", + "variant": "declaration", + "kind": 1024, "flags": {}, - "comment": { - "shortText": "Relationships of the current table." + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 148, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L148" + } + ], + "type": { + "type": "intrinsic", + "name": "string" } }, { - "id": 797, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", + "id": 87, + "name": "timeout", + "variant": "declaration", + "kind": 1024, "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L140" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 97, + "name": "topic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true + }, "comment": { - "shortText": "The select query string literal to parse.\n" + "summary": [ + { + "kind": "text", + "text": "Topic name can be any string." + } + ] }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 153, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L153" + } + ], "type": { "type": "intrinsic", "name": "string" } }, { - "id": 798, - "name": "ClientOptions", - "kind": 131072, - "kindString": "Type parameter", + "id": 131, + "name": "on", + "variant": "declaration", + "kind": 2048, "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ + "sources": [ { - "type": "reference", - "id": 793, - "name": "Schema" + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 385, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 390, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 395, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 411, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 420, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 429, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" + }, + { + "fileName": "src/RealtimeChannel.ts", + "line": 434, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L434" } ], - "name": "IsAny" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 132, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 370, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" + } + ], + "parameters": [ + { + "id": 133, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 134, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 135, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 136, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 372, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [136] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 372, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" + } + ] + } + } + }, + { + "id": 137, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 138, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" + } + ], + "signatures": [ + { + "id": 139, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 373, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { "type": "reference", - "id": 797, - "name": "Query" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } - ], - "name": "ParseQuery" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "name": "ParsedQuery" }, - "extendsType": { - "type": "array", - "elementType": { + { + "id": 140, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" + } + ], + "typeParameters": [ + { + "id": 141, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 142, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" + } + ], + "indexSignatures": [ + { + "id": 143, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 375, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" + } + ], + "parameters": [ + { + "id": 144, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 145, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 146, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 147, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 148, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 377, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [148] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 377, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" + } + ] + } + } + }, + { + "id": 149, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" + } + ], + "signatures": [ + { + "id": 151, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 378, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" + } + ], + "parameters": [ + { + "id": 152, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 641, + "typeArguments": [ + { + "type": "reference", + "target": 141, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceJoinPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { "type": "reference", - "name": "Ast.Node" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 795, - "name": "RelationName" - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "typeArguments": [ + { + "id": 153, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "ParsedQuery" + "kind": "text", + "text": "Creates an event handler that listens to changes." } - ], - "name": "ProcessNodesWithoutSchema" + ] }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "reference", - "name": "ParsedQuery" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 796, - "name": "Relationships" - }, - "extendsType": { - "type": "literal", - "value": null - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ + "sources": [ { - "type": "reference", - "id": 797, - "name": "Query" + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], - "name": "ParseQuery" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "name": "ParsedQuery" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Ast.Node" - } - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ParsedQuery" - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 795, - "name": "RelationName" - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "id": 795, - "name": "RelationName" - }, - "falseType": { - "type": "literal", - "value": "rpc_call" + "typeParameters": [ + { + "id": 154, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" + } + ], + "indexSignatures": [ + { + "id": 156, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 380, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" + } + ], + "parameters": [ + { + "id": 157, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } - }, - { - "type": "reference", - "id": 794, - "name": "Row" } - ], - "name": "RPCCallNodes" - }, - "falseType": { - "type": "reference", - "name": "ParsedQuery" - } - }, - "falseType": { - "type": "reference", - "id": 794, - "name": "Row" - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 797, - "name": "Query" } ], - "name": "ParseQuery" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "name": "ParsedQuery" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Ast.Node" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 795, - "name": "RelationName" - }, - "extendsType": { - "type": "intrinsic", - "name": "string" + "parameters": [ + { + "id": 158, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "id": 796, - "name": "Relationships" - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "name": "GenericRelationship" + { + "id": 159, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 161, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 382, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [161] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 382, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" + } + ] } - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 798, - "name": "ClientOptions" - }, - { - "type": "reference", - "id": 793, - "name": "Schema" - }, - { - "type": "reference", - "id": 794, - "name": "Row" - }, - { - "type": "reference", - "id": 795, - "name": "RelationName" - }, - { - "type": "reference", - "id": 796, - "name": "Relationships" - }, - { - "type": "reference", - "name": "ParsedQuery" - } - ], - "name": "ProcessNodes" - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "Invalid Relationships cannot infer result type" - } - ], - "name": "SelectQueryError" } }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "Invalid RelationName cannot infer result type" + { + "id": 162, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" + } + ], + "signatures": [ + { + "id": 164, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 383, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" + } + ], + "parameters": [ + { + "id": 165, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 651, + "typeArguments": [ + { + "type": "reference", + "target": 154, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceLeavePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ], - "name": "SelectQueryError" - } - }, - "falseType": { - "type": "reference", - "name": "ParsedQuery" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - }, - { - "id": 1, - "name": "default", - "kind": 32, - "kindString": "Variable", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 17, - "character": 0 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestBuilder", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 687, - "name": "default" - } - } - }, - { - "id": 3, - "name": "PostgrestClient", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 9, - "name": "default" - } - } - }, - { - "id": 8, - "name": "PostgrestError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 753, - "name": "default" - } - } - }, - { - "id": 5, - "name": "PostgrestFilterBuilder", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 165, - "name": "default" + } } - } - }, - { - "id": 4, - "name": "PostgrestQueryBuilder", - "kind": 1024, - "kindString": "Property", - "flags": {}, + ], "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 76, - "name": "default" - } + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 6, - "name": "PostgrestTransformBuilder", - "kind": 1024, - "kindString": "Property", + "id": 166, + "name": "on", + "variant": "signature", + "kind": 4096, "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 534, - "name": "default" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [7, 3, 8, 5, 4, 6] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [687, 9, 753, 165, 76, 534] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [767, 773] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [784, 787, 782, 765, 780, 792] - }, - { - "title": "Variables", - "kind": 32, - "children": [1] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 0, - "name": "@supabase/realtime-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 629, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 630, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 98, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L98" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 632, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L100" - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 631, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L99" - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 633, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L101" - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [630, 632, 631, 633] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 97, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L97" - } - ] - }, - { - "id": 634, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 635, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L91" - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 638, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L94" - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 636, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L92" - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 637, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L93" - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [635, 638, 636, 637] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L90" - } - ] - }, - { - "id": 639, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 641, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L37" - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 642, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L38" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 640, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L36" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [641, 642, 640] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L35" - } - ] - }, - { - "id": 643, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 647, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L108" - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 646, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L107" - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 644, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 105, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L105" - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 645, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 385, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" + } + ], + "typeParameters": [ + { + "id": 167, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 168, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 385, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" + } + ], + "indexSignatures": [ + { + "id": 169, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 385, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" + } + ], + "parameters": [ + { + "id": 170, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 171, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 172, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 600, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 173, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 174, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 388, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" + } + ], + "signatures": [ + { + "id": 175, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 388, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" + } + ], + "parameters": [ + { + "id": 176, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 607, + "typeArguments": [ + { + "type": "reference", + "target": 167, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresChangesPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, { - "fileName": "src/RealtimeChannel.ts", - "line": 106, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L106" - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [647, 646, 644, 645] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 104, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L104" - } - ] - }, - { - "id": 59, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - } - ] - }, - "children": [ - { - "id": 70, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ + "id": 177, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 390, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" + } + ], + "typeParameters": [ + { + "id": 178, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 179, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 390, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" + } + ], + "indexSignatures": [ + { + "id": 180, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 390, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" + } + ], + "parameters": [ + { + "id": 181, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 182, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 183, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 600, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 184, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 393, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" + } + ], + "signatures": [ + { + "id": 186, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 393, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" + } + ], + "parameters": [ + { + "id": 187, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 612, + "typeArguments": [ + { + "type": "reference", + "target": 178, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresInsertPayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, { - "fileName": "src/RealtimeChannel.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" - } - ], - "signatures": [ + "id": 188, + "name": "on", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 395, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" + } + ], + "typeParameters": [ + { + "id": 189, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 190, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 395, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" + } + ], + "indexSignatures": [ + { + "id": 191, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 395, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" + } + ], + "parameters": [ + { + "id": 192, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 193, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 194, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 600, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter", + "package": "@supabase/realtime-js" + } + }, + { + "id": 195, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 196, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 398, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" + } + ], + "signatures": [ + { + "id": 197, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 398, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" + } + ], + "parameters": [ + { + "id": 198, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 622, + "typeArguments": [ + { + "type": "reference", + "target": 189, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresUpdatePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, { - "id": 71, - "name": "RealtimeChannel", + "id": 199, + "name": "on", "variant": "signature", - "kind": 16384, + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates an event handler that listens to changes." + } + ] + }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 147, + "line": 400, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" + } + ], + "typeParameters": [ + { + "id": 200, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 201, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" + } + ], + "indexSignatures": [ + { + "id": 202, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 400, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" + } + ], + "parameters": [ + { + "id": 203, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } } ], "parameters": [ { - "id": 72, - "name": "topic", + "id": 204, + "name": "type", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, "type": { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "postgres_changes" } }, { - "id": 73, - "name": "params", + "id": 205, + "name": "filter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 355, - "name": "RealtimeChannelOptions", + "target": 600, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter", "package": "@supabase/realtime-js" - }, - "defaultValue": "..." + } }, { - "id": 74, - "name": "socket", + "id": 206, + "name": "callback", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "reference", - "target": 369, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" + } + ], + "signatures": [ + { + "id": 208, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 403, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" + } + ], + "parameters": [ + { + "id": 209, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 631, + "typeArguments": [ + { + "type": "reference", + "target": 200, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePostgresDeletePayload", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } } } ], @@ -68227,609 +84531,281 @@ "package": "@supabase/realtime-js", "qualifiedName": "default" } - } - ] - }, - { - "id": 75, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ + }, { - "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "id": 210, + "name": "on", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." + } + ] + }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" + "line": 411, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" } ], - "indexSignatures": [ + "parameters": [ { - "id": 77, - "name": "__index", - "variant": "signature", - "kind": 8192, + "id": 211, + "name": "type", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" - } - ], - "parameters": [ - { - "id": 78, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "comment": { + "summary": [ + { + "kind": "text", + "text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." + } + ] + }, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 212, + "name": "filter", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom object specific to the Realtime feature detailing which payloads to receive." } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 213, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 214, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 413, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [214] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 413, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" + } + ] } - ], + } + }, + { + "id": 215, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function to be invoked when event handler is triggered." + } + ] + }, "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 79, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 85, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 132, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L132" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" + "type": "reflection", + "declaration": { + "id": 216, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" + } + ], + "signatures": [ + { + "id": 217, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } - }, - { - "id": 81, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 82, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" - } - ], - "indexSignatures": [ - { - "id": 83, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + ], + "parameters": [ + { + "id": 218, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 219, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 221, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 416, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L416" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 220, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 415, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L415" + } + ], + "type": { + "type": "literal", + "value": "broadcast" } - ], - "parameters": [ - { - "id": 84, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + } + ], + "groups": [ + { + "title": "Properties", + "children": [221, 220] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 414, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" + } + ], + "indexSignatures": [ + { + "id": 222, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 417, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L417" } + ], + "parameters": [ + { + "id": 223, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ], - "type": { - "type": "intrinsic", - "name": "any" } - } - ] - } - } - }, - { - "id": 86, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 133, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L133" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 80, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L130" + ] + } } - ], - "type": { - "type": "intrinsic", - "name": "string" } + ], + "type": { + "type": "intrinsic", + "name": "void" } - ], - "groups": [ - { - "title": "Properties", - "children": [85, 81, 86, 80] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 129, - "character": 19, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" - } - ] - } + } + ] } } } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 94, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 143, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L143" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 89, - "name": "joinedOnce", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L138" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 90, - "name": "joinPush", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 139, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L139" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/push.ts", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 98, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 150, - "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L150" - } - ], - "type": { - "type": "reference", - "target": 355, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 93, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L142" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 96, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L145" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 92, - "name": "pushBuffer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L141" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/push.ts", + ], + "type": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 91, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L140" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/timer.ts", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 99, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 151, - "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L151" - } - ], - "type": { - "type": "reference", - "target": 369, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 88, - "name": "state", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 137, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L137" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "CHANNEL_STATES" - }, - "name": "CHANNEL_STATES", - "package": "@supabase/realtime-js" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 95, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 144, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L144" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 87, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 136, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L136" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 97, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 149, - "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L149" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 360, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 365, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 370, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 380, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 385, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" - }, - { - "fileName": "src/RealtimeChannel.ts", - "line": 414, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" }, { - "fileName": "src/RealtimeChannel.ts", - "line": 419, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L419" - } - ], - "signatures": [ - { - "id": 132, + "id": 224, "name": "on", "variant": "signature", "kind": 4096, @@ -68840,30 +84816,91 @@ "kind": "text", "text": "Creates an event handler that listens to changes." } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 420, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" + } + ], + "typeParameters": [ + { + "id": 225, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 226, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 420, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" + } + ], + "indexSignatures": [ + { + "id": 227, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 420, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" + } + ], + "parameters": [ + { + "id": 228, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } } ], "parameters": [ { - "id": 133, + "id": 229, "name": "type", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "literal", - "value": "presence" + "value": "broadcast" } }, { - "id": 134, + "id": 230, "name": "filter", "variant": "param", "kind": 32768, @@ -68871,14 +84908,14 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 231, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 136, + "id": 232, "name": "event", "variant": "declaration", "kind": 1024, @@ -68886,36 +84923,36 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 422, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ], "type": { - "type": "literal", - "value": "sync" + "type": "intrinsic", + "name": "string" } } ], "groups": [ { "title": "Properties", - "children": [136] + "children": [232] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 422, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ] } } }, { - "id": 137, + "id": 233, "name": "callback", "variant": "param", "kind": 32768, @@ -68923,7 +84960,7 @@ "type": { "type": "reflection", "declaration": { - "id": 138, + "id": 234, "name": "__type", "variant": "declaration", "kind": 65536, @@ -68931,14 +84968,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ], "signatures": [ { - "id": 139, + "id": 235, "name": "__type", "variant": "signature", "kind": 4096, @@ -68946,9 +84983,104 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" + } + ], + "parameters": [ + { + "id": 236, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 239, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 425, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L425" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 240, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 426, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L426" + } + ], + "type": { + "type": "reference", + "target": 225, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + }, + { + "id": 238, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 424, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L424" + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [239, 240, 238] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 423, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" + } + ] + } + } } ], "type": { @@ -68970,7 +85102,7 @@ } }, { - "id": 140, + "id": 241, "name": "on", "variant": "signature", "kind": 4096, @@ -68986,14 +85118,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 429, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "typeParameters": [ { - "id": 141, + "id": 242, "name": "T", "variant": "typeParam", "kind": 131072, @@ -69001,7 +85133,7 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 243, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69009,14 +85141,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 429, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "indexSignatures": [ { - "id": 143, + "id": 244, "name": "__index", "variant": "signature", "kind": 8192, @@ -69024,14 +85156,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 429, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "parameters": [ { - "id": 144, + "id": 245, "name": "key", "variant": "param", "kind": 32768, @@ -69054,18 +85186,18 @@ ], "parameters": [ { - "id": 145, + "id": 246, "name": "type", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "literal", - "value": "presence" + "value": "system" } }, { - "id": 146, + "id": 247, "name": "filter", "variant": "param", "kind": 32768, @@ -69073,51 +85205,16 @@ "type": { "type": "reflection", "declaration": { - "id": 147, + "id": 248, "name": "__type", "variant": "declaration", "kind": 65536, - "flags": {}, - "children": [ - { - "id": 148, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [148] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 362, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" - } - ] + "flags": {} } } }, { - "id": 149, + "id": 249, "name": "callback", "variant": "param", "kind": 32768, @@ -69125,7 +85222,7 @@ "type": { "type": "reflection", "declaration": { - "id": 150, + "id": 250, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69133,14 +85230,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "signatures": [ { - "id": 151, + "id": 251, "name": "__type", "variant": "signature", "kind": 4096, @@ -69148,32 +85245,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "parameters": [ { - "id": 152, + "id": 252, "name": "payload", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "reference", - "target": 599, - "typeArguments": [ - { - "type": "reference", - "target": 141, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" + "type": "intrinsic", + "name": "any" } } ], @@ -69194,32 +85280,41 @@ "package": "@supabase/realtime-js", "qualifiedName": "default" } - }, + } + ] + }, + { + "id": 108, + "name": "presenceState", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ { - "id": 153, - "name": "on", + "fileName": "src/RealtimeChannel.ts", + "line": 335, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" + } + ], + "signatures": [ + { + "id": 109, + "name": "presenceState", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 335, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" } ], "typeParameters": [ { - "id": 154, + "id": 110, "name": "T", "variant": "typeParam", "kind": 131072, @@ -69227,7 +85322,7 @@ "type": { "type": "reflection", "declaration": { - "id": 155, + "id": 111, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69235,14 +85330,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "line": 336, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "indexSignatures": [ { - "id": 156, + "id": 112, "name": "__index", "variant": "signature", "kind": 8192, @@ -69250,14 +85345,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "line": 336, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "parameters": [ { - "id": 157, + "id": 113, "name": "key", "variant": "param", "kind": 32768, @@ -69275,83 +85370,385 @@ } ] } + }, + "default": { + "type": "reflection", + "declaration": { + "id": 114, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + } + ], + "type": { + "type": "reference", + "target": 661, + "typeArguments": [ + { + "type": "reference", + "target": 110, + "name": "T", + "package": "@supabase/realtime-js", + "refersToTypeParameter": true + } + ], + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 253, + "name": "send", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 460, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" + } + ], + "signatures": [ + { + "id": 254, + "name": "send", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sends a message into the channel." } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 460, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" } ], "parameters": [ { - "id": 158, - "name": "type", + "id": 255, + "name": "args", "variant": "param", "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Arguments to send to channel" + } + ] + }, "type": { - "type": "literal", - "value": "presence" + "type": "reflection", + "declaration": { + "id": 256, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 258, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event being sent" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 463, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L463" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 259, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payload to be sent" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 464, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L464" + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 257, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of event to send" + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 462, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L462" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "presence" + }, + { + "type": "literal", + "value": "broadcast" + }, + { + "type": "literal", + "value": "postgres_changes" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [258, 259, 257] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 461, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L461" + } + ], + "indexSignatures": [ + { + "id": 260, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 465, + "character": 6, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L465" + } + ], + "parameters": [ + { + "id": 261, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } } }, { - "id": 159, - "name": "filter", + "id": 262, + "name": "opts", "variant": "param", "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to be used during the send process" + } + ] + }, "type": { "type": "reflection", "declaration": { - "id": 160, + "id": 263, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, - "children": [ + "sources": [ { - "id": 161, - "name": "event", - "variant": "declaration", - "kind": 1024, + "fileName": "src/RealtimeChannel.ts", + "line": 467, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" + } + ], + "indexSignatures": [ + { + "id": 264, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 367, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" + "line": 467, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" + } + ], + "parameters": [ + { + "id": 265, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { - "type": "literal", - "value": "leave" + "type": "intrinsic", + "name": "any" } } - ], - "groups": [ - { - "title": "Properties", - "children": [161] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 367, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" - } ] } - } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, + "typeArguments": [ + { + "type": "reference", + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 100, + "name": "subscribe", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 225, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" + } + ], + "signatures": [ + { + "id": 101, + "name": "subscribe", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Subscribe registers your client with the server" + } + ] + }, + "sources": [ { - "id": 162, + "fileName": "src/RealtimeChannel.ts", + "line": 225, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" + } + ], + "parameters": [ + { + "id": 102, "name": "callback", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { "type": "reflection", "declaration": { - "id": 163, + "id": 103, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69359,14 +85756,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "line": 226, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "signatures": [ { - "id": 164, + "id": 104, "name": "__type", "variant": "signature", "kind": 4096, @@ -69374,33 +85771,42 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "line": 226, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "parameters": [ { - "id": 165, - "name": "payload", + "id": 105, + "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 609, - "typeArguments": [ - { - "type": "reference", - "target": 154, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", + "target": 685, + "name": "REALTIME_SUBSCRIBE_STATES", "package": "@supabase/realtime-js" } + }, + { + "id": 106, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + } } ], "type": { @@ -69411,6 +85817,18 @@ ] } } + }, + { + "id": 107, + "name": "timeout", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." } ], "type": { @@ -69420,10 +85838,27 @@ "package": "@supabase/realtime-js", "qualifiedName": "default" } - }, + } + ] + }, + { + "id": 275, + "name": "teardown", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ { - "id": 166, - "name": "on", + "fileName": "src/RealtimeChannel.ts", + "line": 576, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" + } + ], + "signatures": [ + { + "id": 276, + "name": "teardown", "variant": "signature", "kind": 4096, "flags": {}, @@ -69431,29 +85866,65 @@ "summary": [ { "kind": "text", - "text": "Creates an event handler that listens to changes." + "text": "Teardown the channel.\n\nDestroys and stops related timers." } ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 576, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" } ], - "typeParameters": [ + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 115, + "name": "track", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 341, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" + } + ], + "signatures": [ + { + "id": 116, + "name": "track", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ { - "id": 167, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "fileName": "src/RealtimeChannel.ts", + "line": 341, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" + } + ], + "parameters": [ + { + "id": 117, + "name": "payload", + "variant": "param", + "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 168, + "id": 118, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69461,14 +85932,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "line": 342, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "indexSignatures": [ { - "id": 169, + "id": 119, "name": "__index", "variant": "signature", "kind": 8192, @@ -69476,14 +85947,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "line": 342, + "character": 15, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "parameters": [ { - "id": 170, + "id": 120, "name": "key", "variant": "param", "kind": 32768, @@ -69502,49 +85973,17 @@ ] } } - } - ], - "parameters": [ - { - "id": 171, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 172, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 558, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } }, { - "id": 173, - "name": "callback", + "id": 121, + "name": "opts", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 174, + "id": 122, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69552,71 +85991,88 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "line": 343, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], - "signatures": [ + "indexSignatures": [ { - "id": 175, - "name": "__type", + "id": 123, + "name": "__index", "variant": "signature", - "kind": 4096, + "kind": 8192, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "line": 343, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], "parameters": [ { - "id": 176, - "name": "payload", + "id": 124, + "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "reference", - "target": 565, - "typeArguments": [ - { - "type": "reference", - "target": 167, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" + "type": "intrinsic", + "name": "string" } } ], "type": { "type": "intrinsic", - "name": "void" + "name": "any" } } ] } - } + }, + "defaultValue": "{}" } ], "type": { "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 371, + "name": "RealtimeChannelSendResponse", + "package": "@supabase/realtime-js" + } + ], + "name": "Promise", + "package": "typescript" } - }, + } + ] + }, + { + "id": 272, + "name": "unsubscribe", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ { - "id": 177, - "name": "on", + "fileName": "src/RealtimeChannel.ts", + "line": 537, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" + } + ], + "signatures": [ + { + "id": 273, + "name": "unsubscribe", "variant": "signature", "kind": 4096, "flags": {}, @@ -69624,29 +86080,111 @@ "summary": [ { "kind": "text", - "text": "Creates an event handler that listens to changes." + "text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a " + }, + { + "kind": "code", + "text": "`receive`" + }, + { + "kind": "text", + "text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )" } ] }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 537, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" } ], - "typeParameters": [ + "parameters": [ { - "id": 178, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 274, + "name": "timeout", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 125, + "name": "untrack", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" + } + ], + "signatures": [ + { + "id": 126, + "name": "untrack", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 355, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" + } + ], + "parameters": [ + { + "id": 127, + "name": "opts", + "variant": "param", + "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 179, + "id": 128, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69654,14 +86192,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "line": 356, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "indexSignatures": [ { - "id": 180, + "id": 129, "name": "__index", "variant": "signature", "kind": 8192, @@ -69669,14 +86207,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "line": 356, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "parameters": [ { - "id": 181, + "id": 130, "name": "key", "variant": "param", "kind": 32768, @@ -69694,50 +86232,70 @@ } ] } - } + }, + "defaultValue": "{}" } ], - "parameters": [ - { - "id": 182, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, - { - "id": 183, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { + "typeArguments": [ + { "type": "reference", - "target": 558, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", + "target": 371, + "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } - }, + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 266, + "name": "updateJoinPayload", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 524, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" + } + ], + "signatures": [ + { + "id": 267, + "name": "updateJoinPayload", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 524, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" + } + ], + "parameters": [ { - "id": 184, - "name": "callback", + "id": 268, + "name": "payload", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 269, "name": "__type", "variant": "declaration", "kind": 65536, @@ -69745,53 +86303,42 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "line": 524, + "character": 29, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], - "signatures": [ + "indexSignatures": [ { - "id": 186, - "name": "__type", + "id": 270, + "name": "__index", "variant": "signature", - "kind": 4096, + "kind": 8192, "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "line": 524, + "character": 31, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "parameters": [ { - "id": 187, - "name": "payload", + "id": 271, + "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "reference", - "target": 570, - "typeArguments": [ - { - "type": "reference", - "target": 178, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" + "type": "intrinsic", + "name": "string" } } ], "type": { "type": "intrinsic", - "name": "void" + "name": "any" } } ] @@ -69800,1286 +86347,1576 @@ } ], "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "type": "intrinsic", + "name": "void" } - }, + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [70] + }, + { + "title": "Properties", + "children": [75, 94, 89, 90, 98, 93, 96, 92, 91, 99, 88, 95, 87, 97] + }, + { + "title": "Methods", + "children": [131, 108, 253, 100, 275, 115, 272, 125, 266] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 131, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L131" + } + ] + }, + { + "id": 372, + "name": "RealtimeClient", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 373, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ { - "id": 188, - "name": "on", + "fileName": "src/RealtimeClient.ts", + "line": 171, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" + } + ], + "signatures": [ + { + "id": 374, + "name": "RealtimeClient", "variant": "signature", - "kind": 4096, + "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Creates an event handler that listens to changes." + "text": "Initializes the Socket." } ] }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 380, + "fileName": "src/RealtimeClient.ts", + "line": 171, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" } ], - "typeParameters": [ + "parameters": [ { - "id": 189, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 375, + "name": "endPoint", + "variant": "param", + "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + } + ] + }, "type": { - "type": "reflection", - "declaration": { - "id": 190, + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 376, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 564, + "name": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "highlightedProperties": { + "transport": [ + { + "kind": "text", + "text": "The Websocket Transport, for example WebSocket. This can be a custom implementation" + } + ], + "timeout": [ + { + "kind": "text", + "text": "The default timeout in milliseconds to trigger push timeouts." + } + ], + "params": [ + { + "kind": "text", + "text": "The optional params to pass when connecting." + } + ], + "headers": [ + { + "kind": "text", + "text": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." + } + ], + "heartbeatIntervalMs": [ + { + "kind": "text", + "text": "The millisec interval to send a heartbeat message." + } + ], + "heartbeatCallback": [ + { + "kind": "text", + "text": "The optional function to handle heartbeat status." + } + ], + "logger": [ + { + "kind": "text", + "text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(" + }, + { + "kind": "code", + "text": "`${kind}: ${msg}`" + }, + { + "kind": "text", + "text": ", data) }" + } + ], + "logLevel": [ + { + "kind": "text", + "text": "Sets the log level for Realtime" + } + ], + "encode": [ + { + "kind": "text", + "text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))" + } + ], + "decode": [ + { + "kind": "text", + "text": "The function to decode incoming messages. Defaults to Serializer's decode." + } + ], + "reconnectAfterMs": [ + { + "kind": "text", + "text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off." + } + ], + "worker": [ + { + "kind": "text", + "text": "Use Web Worker to set a side flow. Defaults to false." + } + ], + "workerUrl": [ + { + "kind": "text", + "text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive." + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 372, + "name": "RealtimeClient", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + } + ] + }, + { + "id": 423, + "name": "accessToken", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 424, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" + } + ], + "signatures": [ + { + "id": 425, "name": "__type", - "variant": "declaration", - "kind": 65536, + "variant": "signature", + "kind": 4096, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 380, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "fileName": "src/RealtimeClient.ts", + "line": 144, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], - "indexSignatures": [ - { - "id": 191, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 380, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" - } - ], - "parameters": [ - { - "id": 192, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { "type": "intrinsic", "name": "string" } - } - ], - "type": { - "type": "intrinsic", - "name": "any" + ] } - } - ] + ], + "name": "Promise", + "package": "typescript" + } } - } + ] } - ], - "parameters": [ + } + ] + }, + "defaultValue": "null" + }, + { + "id": 377, + "name": "accessTokenValue", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L108" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 378, + "name": "apiKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 109, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L109" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 379, + "name": "channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L110" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + }, + "defaultValue": "..." + }, + { + "id": 406, + "name": "conn", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 129, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L129" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 404, + "name": "decode", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 127, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L127" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 403, + "name": "encode", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 126, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L126" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 380, + "name": "endPoint", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 111, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L111" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 415, + "name": "fetch", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 143, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L143" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 416, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ { - "id": 193, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 29329, + "character": 17 }, { - "id": 194, - "name": "filter", - "variant": "param", - "kind": 32768, + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], + "signatures": [ + { + "id": 417, + "name": "__type", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 29329, + "character": 17 + } + ], + "parameters": [ + { + "id": 418, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInfo" + }, + "name": "RequestInfo", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 419, + "name": "init", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" + } + } + ], "type": { "type": "reference", - "target": 558, + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, "typeArguments": [ { - "type": "literal", - "value": "UPDATE" + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" } ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" + "name": "Promise", + "package": "typescript" } }, { - "id": 195, - "name": "callback", - "variant": "param", - "kind": 32768, + "id": 420, + "name": "__type", + "variant": "signature", + "kind": 4096, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + } + ] + }, + "sources": [ + { + "fileName": "node_modules/@types/node/globals.d.ts", + "line": 374, + "character": 13 + } + ], + "parameters": [ + { + "id": 421, + "name": "input", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 383, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" - } - ], - "signatures": [ - { - "id": 197, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 383, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" - } - ], - "parameters": [ - { - "id": 198, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 580, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { + "type": { + "type": "union", + "types": [ + { "type": "intrinsic", - "name": "void" + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Request" + }, + "name": "Request", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } - } - ] + ] + } + }, + { + "id": 422, + "name": "init", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "RequestInit" + }, + "name": "RequestInit", + "package": "typescript" + } } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Response" + }, + "name": "Response", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" } } - ], - "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 199, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ + ] + } + } + }, + { + "id": 382, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ { "kind": "text", - "text": "Creates an event handler that listens to changes." + "text": "headers cannot be set on websocket connections" } ] - }, + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 114, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 385, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "fileName": "src/RealtimeClient.ts", + "line": 114, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], - "typeParameters": [ + "indexSignatures": [ { - "id": 200, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 384, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 385, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" - } - ], - "indexSignatures": [ - { - "id": 202, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 385, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" - } - ], - "parameters": [ - { - "id": 203, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 114, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } - } - } - ], - "parameters": [ - { - "id": 204, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 205, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 558, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 206, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "variant": "declaration", - "kind": 65536, + ], + "parameters": [ + { + "id": 385, + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 388, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" - } - ], - "signatures": [ - { - "id": 208, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 388, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" - } - ], - "parameters": [ - { - "id": 209, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 589, - "typeArguments": [ - { - "type": "reference", - "target": 200, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } } + ], + "type": { + "type": "intrinsic", + "name": "string" } } - ], - "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 395, + "name": "heartbeatCallback", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ { - "id": 210, - "name": "on", - "variant": "signature", - "kind": 4096, + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 396, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The following is placed here to display on supabase.com/docs/reference/javascript/subscribe." - } - ] - }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 396, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], - "parameters": [ - { - "id": 211, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of \"broadcast\", \"presence\", or \"postgres_changes\"." - } - ] - }, - "type": { - "type": "literal", - "value": "broadcast" - } - }, + "signatures": [ { - "id": 212, - "name": "filter", - "variant": "param", - "kind": 32768, + "id": 397, + "name": "__type", + "variant": "signature", + "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 213, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 214, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 398, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [214] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 398, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" - } - ] + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 121, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } - } - }, - { - "id": 215, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, + ], + "parameters": [ + { + "id": 398, + "name": "status", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 399, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" - } - ], - "signatures": [ - { - "id": 217, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 399, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" - } - ], - "parameters": [ - { - "id": 218, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 221, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 401, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L401" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 220, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 400, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L400" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [221, 220] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 399, - "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" - } - ], - "indexSignatures": [ - { - "id": 222, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 402, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L402" - } - ], - "parameters": [ - { - "id": 223, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "HeartbeatStatus" + }, + "name": "HeartbeatStatus", + "package": "@supabase/realtime-js" + } } + ], + "type": { + "type": "intrinsic", + "name": "void" } } - ], - "type": { + ] + } + }, + "defaultValue": "noop" + }, + { + "id": 392, + "name": "heartbeatIntervalMs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L118" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "CONNECTION_TIMEOUTS.HEARTBEAT_INTERVAL" + }, + { + "id": 393, + "name": "heartbeatTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 119, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L119" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "target": { + "sourceFileName": "node_modules/@types/node/timers.d.ts", + "qualifiedName": "__global.NodeJS.Timeout" + }, + "name": "Timeout", + "package": "@types/node", + "qualifiedName": "__global.NodeJS.Timeout" } + ] + }, + "defaultValue": "undefined" + }, + { + "id": 381, + "name": "httpEndpoint", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 401, + "name": "logger", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 124, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L124" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" }, + "name": "Function", + "package": "typescript" + }, + "defaultValue": "noop" + }, + { + "id": 402, + "name": "logLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ { - "id": 224, - "name": "on", - "variant": "signature", - "kind": 4096, + "fileName": "src/RealtimeClient.ts", + "line": 125, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L125" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "LogLevel" + }, + "name": "LogLevel", + "package": "@supabase/realtime-js" + } + }, + { + "id": 386, + "name": "params", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 115, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 387, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" - } - ], - "typeParameters": [ - { - "id": 225, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 226, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" - } - ], - "indexSignatures": [ - { - "id": 227, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 405, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" - } - ], - "parameters": [ - { - "id": 228, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } + "fileName": "src/RealtimeClient.ts", + "line": 115, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], - "parameters": [ - { - "id": 229, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, + "indexSignatures": [ { - "id": 230, - "name": "filter", - "variant": "param", - "kind": 32768, + "id": 388, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 231, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 232, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 407, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [232] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 407, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" - } - ] + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 115, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } - } - }, - { - "id": 233, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 234, - "name": "__type", - "variant": "declaration", - "kind": 65536, + ], + "parameters": [ + { + "id": 389, + "name": "key", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 408, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" - } - ], - "signatures": [ - { - "id": 235, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 408, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" - } - ], - "parameters": [ - { - "id": 236, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 237, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 239, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 410, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L410" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 240, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 411, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L411" - } - ], - "type": { - "type": "reference", - "target": 225, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 238, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 409, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L409" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [239, 240, 238] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 408, - "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } } + ], + "type": { + "type": "intrinsic", + "name": "string" } } - ], - "type": { + ] + } + }, + "defaultValue": "{}" + }, + { + "id": 394, + "name": "pendingHeartbeatRef", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 120, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L120" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 405, + "name": "reconnectAfterMs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 128, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L128" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + { + "id": 400, + "name": "reconnectTimer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 123, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L123" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { "type": "reference", - "target": 59, - "name": "RealtimeChannel", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", "package": "@supabase/realtime-js", "qualifiedName": "default" } + ] + }, + "defaultValue": "null" + }, + { + "id": 399, + "name": "ref", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 122, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L122" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 407, + "name": "sendBuffer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 130, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L130" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } + }, + "defaultValue": "[]" + }, + { + "id": 408, + "name": "serializer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 131, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L131" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/lib/serializer.ts", + "qualifiedName": "default" }, + "name": "Serializer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + }, + "defaultValue": "..." + }, + { + "id": 409, + "name": "stateChangeCallbacks", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ { - "id": 241, - "name": "on", - "variant": "signature", - "kind": 4096, + "fileName": "src/RealtimeClient.ts", + "line": 132, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 410, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 414, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" - } - ], - "typeParameters": [ + "children": [ { - "id": 242, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 412, + "name": "close", + "variant": "declaration", + "kind": 1024, "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 134, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L134" + } + ], "type": { - "type": "reflection", - "declaration": { - "id": 243, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 414, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" - } - ], - "indexSignatures": [ - { - "id": 244, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 414, - "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" - } - ], - "parameters": [ - { - "id": 245, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } - } - ], - "parameters": [ + }, { - "id": 246, - "name": "type", - "variant": "param", - "kind": 32768, + "id": 413, + "name": "error", + "variant": "declaration", + "kind": 1024, "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 135, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L135" + } + ], "type": { - "type": "literal", - "value": "system" + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" + } } }, { - "id": 247, - "name": "filter", - "variant": "param", - "kind": 32768, + "id": 414, + "name": "message", + "variant": "declaration", + "kind": 1024, "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 136, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L136" + } + ], "type": { - "type": "reflection", - "declaration": { - "id": 248, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } }, { - "id": 249, - "name": "callback", - "variant": "param", - "kind": 32768, + "id": 411, + "name": "open", + "variant": "declaration", + "kind": 1024, "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 133, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L133" + } + ], "type": { - "type": "reflection", - "declaration": { - "id": 250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 417, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" - } - ], - "signatures": [ - { - "id": 251, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 417, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" - } - ], - "parameters": [ - { - "id": 252, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Function" + }, + "name": "Function", + "package": "typescript" } } } ], - "type": { + "groups": [ + { + "title": "Properties", + "children": [412, 413, 414, 411] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 132, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 390, + "name": "timeout", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L116" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 391, + "name": "transport", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L117" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "target": 758, + "name": "WebSocketLikeConstructor", + "package": "@supabase/realtime-js" } + ] + }, + "defaultValue": "null" + }, + { + "id": 426, + "name": "worker", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 145, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L145" } - ] + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } }, { - "id": 108, - "name": "presenceState", + "id": 428, + "name": "workerRef", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 147, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L147" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Worker" + }, + "name": "Worker", + "package": "typescript" + } + }, + { + "id": 427, + "name": "workerUrl", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L146" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "channel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 320, + "fileName": "src/RealtimeClient.ts", + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], "signatures": [ { - "id": 109, - "name": "presenceState", + "id": 461, + "name": "channel", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 320, + "fileName": "src/RealtimeClient.ts", + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], - "typeParameters": [ + "parameters": [ { - "id": 110, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 462, + "name": "topic", + "variant": "param", + "kind": 32768, "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" - } - ], - "indexSignatures": [ - { - "id": 112, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 321, - "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" - } - ], - "parameters": [ - { - "id": 113, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 114, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } + "type": "intrinsic", + "name": "string" } + }, + { + "id": 463, + "name": "params", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 358, + "name": "RealtimeChannelOptions", + "package": "@supabase/realtime-js" + }, + "defaultValue": "..." } ], "type": { "type": "reference", - "target": 619, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } } ] }, { - "id": 253, - "name": "send", + "id": 432, + "name": "connect", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 445, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "fileName": "src/RealtimeClient.ts", + "line": 190, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], "signatures": [ { - "id": 254, - "name": "send", + "id": 433, + "name": "connect", "variant": "signature", "kind": 4096, "flags": {}, @@ -71087,297 +87924,92 @@ "summary": [ { "kind": "text", - "text": "Sends a message into the channel." + "text": "Connects the socket, unless already connected." } ] }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 445, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "fileName": "src/RealtimeClient.ts", + "line": 190, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], - "parameters": [ - { - "id": 255, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 256, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 258, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 448, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L448" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 259, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 449, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L449" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 257, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 447, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L447" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [258, 259, 257] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 446, - "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L446" - } - ], - "indexSignatures": [ - { - "id": 260, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 450, - "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L450" - } - ], - "parameters": [ - { - "id": 261, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 452, + "name": "connectionState", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" + } + ], + "signatures": [ + { + "id": 453, + "name": "connectionState", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the current state of the socket." } - }, + ] + }, + "sources": [ { - "id": 262, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 263, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 452, - "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" - } - ], - "indexSignatures": [ - { - "id": 264, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 452, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" - } - ], - "parameters": [ - { - "id": 265, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" + "fileName": "src/RealtimeClient.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" } ], "type": { "type": "reference", "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "sourceFileName": "src/lib/constants.ts", + "qualifiedName": "CONNECTION_STATE" }, - "typeArguments": [ - { - "type": "reference", - "target": 368, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" + "name": "CONNECTION_STATE", + "package": "@supabase/realtime-js" } } ] }, { - "id": 100, - "name": "subscribe", + "id": 436, + "name": "disconnect", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 213, + "fileName": "src/RealtimeClient.ts", + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "signatures": [ { - "id": 101, - "name": "subscribe", + "id": 437, + "name": "disconnect", "variant": "signature", "kind": 4096, "flags": {}, @@ -71385,141 +88017,87 @@ "summary": [ { "kind": "text", - "text": "Subscribe registers your client with the server" + "text": "Disconnects the socket." } ] }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 213, + "fileName": "src/RealtimeClient.ts", + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "parameters": [ { - "id": 102, - "name": "callback", + "id": 438, + "name": "code", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A numeric status code to send on disconnect." + } + ] + }, "type": { - "type": "reflection", - "declaration": { - "id": 103, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 214, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" - } - ], - "signatures": [ - { - "id": 104, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 214, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" - } - ], - "parameters": [ - { - "id": 105, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 643, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 106, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } + "type": "intrinsic", + "name": "number" } }, { - "id": 107, - "name": "timeout", + "id": 439, + "name": "reason", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom reason for the disconnect." + } + ] + }, "type": { "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." + "name": "string" + } } ], "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "type": "intrinsic", + "name": "void" } } ] }, { - "id": 275, - "name": "teardown", + "id": 434, + "name": "endpointURL", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 561, + "fileName": "src/RealtimeClient.ts", + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "signatures": [ { - "id": 276, - "name": "teardown", + "id": 435, + "name": "endpointURL", "variant": "signature", "kind": 4096, "flags": {}, @@ -71527,213 +88105,148 @@ "summary": [ { "kind": "text", - "text": "Teardown the channel.\n\nDestroys and stops related timers." + "text": "Returns the URL of the websocket." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "string The URL of the websocket." + } + ] } ] }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 561, + "fileName": "src/RealtimeClient.ts", + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "type": { "type": "intrinsic", - "name": "void" + "name": "string" } } ] }, { - "id": 115, - "name": "track", + "id": 478, + "name": "flushSendBuffer", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 326, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "fileName": "src/RealtimeClient.ts", + "line": 482, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], "signatures": [ { - "id": 116, - "name": "track", + "id": 479, + "name": "flushSendBuffer", "variant": "signature", "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Flushes send buffer" + } + ] + }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 326, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "fileName": "src/RealtimeClient.ts", + "line": 482, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], - "parameters": [ - { - "id": 117, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 327, - "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" - } - ], - "indexSignatures": [ - { - "id": 119, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 327, - "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" - } - ], - "parameters": [ - { - "id": 120, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 440, + "name": "getChannels", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 287, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" + } + ], + "signatures": [ + { + "id": 441, + "name": "getChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns all created channels" } - }, + ] + }, + "sources": [ { - "id": 121, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 328, - "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" - } - ], - "indexSignatures": [ - { - "id": 123, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 328, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" - } - ], - "parameters": [ - { - "id": 124, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" + "fileName": "src/RealtimeClient.ts", + "line": 287, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 368, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" + "type": "array", + "elementType": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } } } ] }, { - "id": 272, - "name": "unsubscribe", + "id": 454, + "name": "isConnected", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 522, + "fileName": "src/RealtimeClient.ts", + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "signatures": [ { - "id": 273, - "name": "unsubscribe", + "id": 455, + "name": "isConnected", "variant": "signature", "kind": 4096, "flags": {}, @@ -71741,1435 +88254,1051 @@ "summary": [ { "kind": "text", - "text": "Leaves the channel.\n\nUnsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a " + "text": "Returns " }, { "kind": "code", - "text": "`receive`" + "text": "`true`" }, { "kind": "text", - "text": " hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )" + "text": " is the connection is open." } ] }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 522, + "fileName": "src/RealtimeClient.ts", + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" - } - ], - "parameters": [ - { - "id": 274, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "boolean" } } ] }, { - "id": 125, - "name": "untrack", + "id": 456, + "name": "isConnecting", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 340, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" + "fileName": "src/RealtimeClient.ts", + "line": 354, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], "signatures": [ { - "id": 126, - "name": "untrack", + "id": 457, + "name": "isConnecting", "variant": "signature", "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " if the connection is currently connecting." + } + ] + }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 340, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" - } - ], - "parameters": [ - { - "id": 127, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 341, - "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" - } - ], - "indexSignatures": [ - { - "id": 129, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 341, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" - } - ], - "parameters": [ - { - "id": 130, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" + "fileName": "src/RealtimeClient.ts", + "line": 354, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 368, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "boolean" } } ] }, { - "id": 266, - "name": "updateJoinPayload", + "id": 458, + "name": "isDisconnecting", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 509, + "fileName": "src/RealtimeClient.ts", + "line": 361, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" } ], "signatures": [ { - "id": 267, - "name": "updateJoinPayload", + "id": 459, + "name": "isDisconnecting", "variant": "signature", "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " if the connection is currently disconnecting." + } + ] + }, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 509, + "fileName": "src/RealtimeClient.ts", + "line": 361, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" - } - ], - "parameters": [ - { - "id": 268, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 509, - "character": 29, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" - } - ], - "indexSignatures": [ - { - "id": 270, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 509, - "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" - } - ], - "parameters": [ - { - "id": 271, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" } ], "type": { "type": "intrinsic", - "name": "void" + "name": "boolean" } } ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [70] - }, - { - "title": "Properties", - "children": [75, 94, 89, 90, 98, 93, 96, 92, 91, 99, 88, 95, 87, 97] }, { - "title": "Methods", - "children": [131, 108, 253, 100, 275, 115, 272, 125, 266] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 127, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L127" - } - ] - }, - { - "id": 369, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 370, - "name": "constructor", + "id": 447, + "name": "log", "variant": "declaration", - "kind": 512, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 324, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" } ], "signatures": [ { - "id": 371, - "name": "RealtimeClient", + "id": 448, + "name": "log", "variant": "signature", - "kind": 16384, + "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initializes the Socket." + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." } ] }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 324, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" } ], "parameters": [ { - "id": 372, - "name": "endPoint", + "id": 449, + "name": "kind", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 373, - "name": "options", + "id": 450, + "name": "msg", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, + "name": "data", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { - "type": "reference", - "target": 526, - "name": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "highlightedProperties": { - "transport": [ - { - "kind": "text", - "text": "The Websocket Transport, for example WebSocket. This can be a custom implementation" - } - ], - "timeout": [ - { - "kind": "text", - "text": "The default timeout in milliseconds to trigger push timeouts." - } - ], - "params": [ - { - "kind": "text", - "text": "The optional params to pass when connecting." - } - ], - "headers": [ - { - "kind": "text", - "text": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "logger": [ - { - "kind": "text", - "text": "The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(" - }, - { - "kind": "code", - "text": "`${kind}: ${msg}`" - }, - { - "kind": "text", - "text": ", data) }" - } - ], - "logLevel": [ - { - "kind": "text", - "text": "Sets the log level for Realtime" - } - ], - "encode": [ - { - "kind": "text", - "text": "The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))" - } - ], - "decode": [ - { - "kind": "text", - "text": "The function to decode incoming messages. Defaults to Serializer's decode." - } - ], - "reconnectAfterMs": [ - { - "kind": "text", - "text": "he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off." - } - ], - "worker": [ - { - "kind": "text", - "text": "Use Web Worker to set a side flow. Defaults to false." - } - ], - "workerUrl": [ - { - "kind": "text", - "text": "The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive." - } - ] - } + "type": "intrinsic", + "name": "any" } } ], "type": { - "type": "reference", - "target": 369, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "type": "intrinsic", + "name": "void" } } ] }, { - "id": 420, - "name": "accessToken", + "id": 472, + "name": "onHeartbeat", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 476, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 421, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "signatures": [ + { + "id": 473, + "name": "onHeartbeat", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 476, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" + } + ], + "parameters": [ + { + "id": 474, + "name": "callback", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 127, - "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" - } - ], - "signatures": [ - { - "id": 422, + "type": { + "type": "reflection", + "declaration": { + "id": 475, "name": "__type", - "variant": "signature", - "kind": 4096, + "variant": "declaration", + "kind": 65536, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, - "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "line": 476, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" + "signatures": [ + { + "id": 476, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 476, + "character": 24, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" + } + ], + "parameters": [ + { + "id": 477, + "name": "status", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "HeartbeatStatus" + }, + "name": "HeartbeatStatus", + "package": "@supabase/realtime-js" } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 374, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L91" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 375, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L92" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { "type": "intrinsic", - "name": "string" + "name": "void" } - ] - }, - "defaultValue": "null" + } + ] }, { - "id": 376, - "name": "channels", + "id": 464, + "name": "push", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, + "line": 389, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L93" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" } ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "signatures": [ + { + "id": 465, + "name": "push", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" + } + ], + "parameters": [ + { + "id": 466, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 593, + "name": "RealtimeMessage", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } } - }, - "defaultValue": "..." + ] }, { - "id": 403, - "name": "conn", + "id": 445, + "name": "removeAllChannels", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L112" + "line": 310, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" } ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null + "signatures": [ + { + "id": 446, + "name": "removeAllChannels", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all channels" + } + ] }, - { + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 310, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" + } + ], + "type": { "type": "reference", "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, - "name": "WebSocket", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 670, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" + } + } + ], + "name": "Promise", "package": "typescript" } - ] - }, - "defaultValue": "null" - }, - { - "id": 401, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 110, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L110" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - }, - { - "id": 400, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L109" } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } + ] }, { - "id": 377, - "name": "endPoint", + "id": 442, + "name": "removeChannel", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L94" + "line": 295, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 412, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ + "signatures": [ { - "fileName": "src/RealtimeClient.ts", - "line": 126, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L126" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "id": 443, + "name": "removeChannel", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes a single channel" + } + ] + }, "sources": [ { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 374, - "character": 13 + "fileName": "src/RealtimeClient.ts", + "line": 295, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], - "signatures": [ + "parameters": [ { - "id": 414, - "name": "__type", - "variant": "signature", - "kind": 4096, + "id": 444, + "name": "channel", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" + "text": "A RealtimeChannel instance" } ] }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 415, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 416, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], "type": { "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" }, - { - "id": 417, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 374, - "character": 13 - } - ], - "parameters": [ - { - "id": 418, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 419, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { + "typeArguments": [ + { "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" + "target": 670, + "name": "RealtimeRemoveChannelResponse", + "package": "@supabase/realtime-js" } - } - ] + ], + "name": "Promise", + "package": "typescript" + } } - } + ] }, { - "id": 379, - "name": "headers", + "id": 470, + "name": "sendHeartbeat", "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, + "kind": 2048, + "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "line": 424, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 380, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "signatures": [ + { + "id": 471, + "name": "sendHeartbeat", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sends a heartbeat message if the socket is connected." + } + ] + }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "line": 424, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], - "indexSignatures": [ - { - "id": 381, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 97, - "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" - } - ], - "parameters": [ - { - "id": 382, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { "type": "intrinsic", - "name": "string" + "name": "void" } - } - ] + ], + "name": "Promise", + "package": "typescript" + } } - }, - "defaultValue": "{}" + ] }, { - "id": 392, - "name": "heartbeatCallback", + "id": 467, + "name": "setAuth", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "line": 413, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 393, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "signatures": [ + { + "id": 468, + "name": "setAuth", + "variant": "signature", + "kind": 4096, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the " + }, + { + "kind": "code", + "text": "`accessToken`" + }, + { + "kind": "text", + "text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client." + } + ] + }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "line": 413, + "character": 8, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], - "signatures": [ + "parameters": [ { - "id": 394, - "name": "__type", - "variant": "signature", - "kind": 4096, + "id": 469, + "name": "token", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 104, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" - } - ], - "parameters": [ - { - "id": 395, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" + "comment": { + "summary": [ + { + "kind": "text", + "text": "A JWT string to override the token set on the client." } - } - ], + ] + }, "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { "type": "intrinsic", "name": "void" } - } - ] + ], + "name": "Promise", + "package": "typescript" + } } - }, - "defaultValue": "noop" + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [373] }, { - "id": 389, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "25000" + "title": "Properties", + "children": [ + 423, 377, 378, 379, 406, 404, 403, 380, 415, 382, 395, 392, 393, 381, 401, 402, 386, + 394, 405, 400, 399, 407, 408, 409, 390, 391, 426, 428, 427 + ] }, { - "id": 390, - "name": "heartbeatTimer", + "title": "Methods", + "children": [ + 460, 432, 452, 436, 434, 478, 440, 454, 456, 458, 447, 472, 464, 445, 442, 470, 467 + ] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 107, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L107" + } + ] + }, + { + "id": 1, + "name": "RealtimePresence", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 30, + "name": "constructor", "variant": "declaration", - "kind": 1024, + "kind": 512, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 102, + "fileName": "src/RealtimePresence.ts", + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L102" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" + "signatures": [ + { + "id": 31, + "name": "RealtimePresence", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initializes the Presence." + } + ] }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 85, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" + } + ], + "parameters": [ + { + "id": 32, + "name": "channel", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The RealtimeChannel" + } + ] + }, + "type": { + "type": "reference", + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" + { + "id": 33, + "name": "opts", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The options,\n for example " + }, + { + "kind": "code", + "text": "`{events: {state: 'state', diff: 'diff'}}`" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOpts" + }, + "name": "PresenceOpts", + "package": "@types/phoenix" + } + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "RealtimePresence", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 378, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 95, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L95" } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" + ] }, { - "id": 398, - "name": "logger", + "id": 38, + "name": "caller", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L107" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "defaultValue": "noop" - }, - { - "id": 399, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L108" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 383, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 98, + "fileName": "src/RealtimePresence.ts", + "line": 68, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" } ], "type": { "type": "reflection", "declaration": { - "id": 384, + "id": 39, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" - } - ], - "indexSignatures": [ + "id": 40, + "name": "onJoin", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 69, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L69" + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnJoinCallback" + }, + "name": "PresenceOnJoinCallback", + "package": "@types/phoenix" + } + }, { - "id": 385, - "name": "__index", - "variant": "signature", - "kind": 8192, + "id": 41, + "name": "onLeave", + "variant": "declaration", + "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 98, - "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "fileName": "src/RealtimePresence.ts", + "line": 70, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L70" } ], - "parameters": [ + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/@types/phoenix/index.d.ts", + "qualifiedName": "PresenceOnLeaveCallback" + }, + "name": "PresenceOnLeaveCallback", + "package": "@types/phoenix" + } + }, + { + "id": 42, + "name": "onSync", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ { - "id": 386, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/RealtimePresence.ts", + "line": 71, + "character": 4, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 43, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 71, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" + } + ], + "signatures": [ + { + "id": 44, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 71, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } } } + ], + "groups": [ + { + "title": "Properties", + "children": [40, 41, 42] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 68, + "character": 10, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" + } ] } }, - "defaultValue": "{}" + "defaultValue": "..." }, { - "id": 391, - "name": "pendingHeartbeatRef", + "id": 45, + "name": "channel", "variant": "declaration", "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 103, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L103" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, + "flags": { + "isPublic": true + }, + "comment": { + "summary": [ { - "type": "intrinsic", - "name": "string" + "kind": "text", + "text": "The RealtimeChannel" } ] }, - "defaultValue": "null" - }, - { - "id": 402, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": {}, "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L111" + { + "fileName": "src/RealtimePresence.ts", + "line": 85, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "type": { "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" + "target": 59, + "name": "RealtimeChannel", + "package": "@supabase/realtime-js", + "qualifiedName": "default" } }, { - "id": 397, - "name": "reconnectTimer", + "id": 37, + "name": "enabled", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 106, + "fileName": "src/RealtimePresence.ts", + "line": 67, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L106" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L67" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/timer.ts", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" }, { - "id": 396, - "name": "ref", + "id": 36, + "name": "joinRef", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 105, + "fileName": "src/RealtimePresence.ts", + "line": 66, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L105" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L66" } ], "type": { - "type": "intrinsic", - "name": "number" + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] }, - "defaultValue": "0" + "defaultValue": "null" }, { - "id": 404, - "name": "sendBuffer", + "id": 35, + "name": "pendingDiffs", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 113, + "fileName": "src/RealtimePresence.ts", + "line": 65, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L113" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L65" } ], "type": { @@ -73177,809 +89306,1059 @@ "elementType": { "type": "reference", "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" + "sourceFileName": "src/RealtimePresence.ts", + "qualifiedName": "RawPresenceDiff" }, - "name": "Function", - "package": "typescript" + "name": "RawPresenceDiff", + "package": "@supabase/realtime-js" } }, "defaultValue": "[]" }, { - "id": 405, - "name": "serializer", + "id": 34, + "name": "state", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 114, + "fileName": "src/RealtimePresence.ts", + "line": 64, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L114" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "target": { - "sourceFileName": "src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "target": 661, + "name": "RealtimePresenceState", + "package": "@supabase/realtime-js" }, - "defaultValue": "..." + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [30] }, { - "id": 406, - "name": "stateChangeCallbacks", + "title": "Properties", + "children": [38, 45, 37, 36, 35, 34] + } + ], + "sources": [ + { + "fileName": "src/RealtimePresence.ts", + "line": 63, + "character": 21, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L63" + } + ] + }, + { + "id": 691, + "name": "WebSocketFactory", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 706, + "name": "constructor", "variant": "declaration", - "kind": 1024, + "kind": 512, "flags": {}, + "signatures": [ + { + "id": 707, + "name": "WebSocketFactory", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 691, + "name": "WebSocketFactory", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 700, + "name": "createWebSocket", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" } ], - "type": { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "signatures": [ + { + "id": 701, + "name": "createWebSocket", + "variant": "signature", + "kind": 4096, "flags": {}, - "children": [ + "sources": [ { - "id": 409, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L117" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - } - }, + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" + } + ], + "parameters": [ { - "id": 410, - "name": "error", - "variant": "declaration", - "kind": 1024, + "id": 702, + "name": "url", + "variant": "param", + "kind": 32768, "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L118" - } - ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" }, - "name": "Function", - "package": "typescript" - } + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] } }, { - "id": 411, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L119" - } - ], + "id": 703, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" }, - "name": "Function", - "package": "typescript" - } + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] } - }, + } + ], + "type": { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 694, + "name": "getWebSocketConstructor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" + } + ], + "signatures": [ + { + "id": 695, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ { - "id": 408, - "name": "open", + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 696, + "name": "__type", "variant": "declaration", - "kind": 1024, + "kind": 65536, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L116" + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26772, + "character": 23 } ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" + "signatures": [ + { + "id": 697, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26774, + "character": 4 + } + ], + "parameters": [ + { + "id": 698, + "name": "url", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 699, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "WebSocket" + }, + "name": "WebSocket", + "package": "typescript" + } } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [409, 410, 411, 408] + ] } - ], + } + } + ] + }, + { + "id": 704, + "name": "isWebSocketSupported", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" + } + ], + "signatures": [ + { + "id": 705, + "name": "isWebSocketSupported", + "variant": "signature", + "kind": 4096, + "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 115, - "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" } - ] + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } - }, - "defaultValue": "..." + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [706] }, { - "id": 387, - "name": "timeout", + "title": "Methods", + "children": [700, 694, 704] + } + ], + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 35, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L35" + } + ] + }, + { + "id": 708, + "name": "WebSocketLike", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 751, + "name": "binaryType", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 99, + "fileName": "src/lib/websocket-factory.ts", + "line": 22, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L99" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L22" } ], "type": { "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" + "name": "string" + } }, { - "id": 388, - "name": "transport", + "id": 752, + "name": "bufferedAmount", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 100, + "fileName": "src/lib/websocket-factory.ts", + "line": 23, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L100" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L23" } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - ] + "type": "intrinsic", + "name": "number" } }, { - "id": 423, - "name": "worker", + "id": 712, + "name": "CLOSED", "variant": "declaration", "kind": 1024, "flags": { - "isOptional": true + "isReadonly": true }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L128" + "fileName": "src/lib/websocket-factory.ts", + "line": 5, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L5" } ], "type": { "type": "intrinsic", - "name": "boolean" + "name": "number" } }, { - "id": 425, - "name": "workerRef", + "id": 711, + "name": "CLOSING", "variant": "declaration", "kind": 1024, "flags": { - "isOptional": true + "isReadonly": true }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 130, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L130" + "fileName": "src/lib/websocket-factory.ts", + "line": 4, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L4" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" + "type": "intrinsic", + "name": "number" } }, { - "id": 424, - "name": "workerUrl", + "id": 709, + "name": "CONNECTING", "variant": "declaration", "kind": 1024, "flags": { - "isOptional": true + "isReadonly": true }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L129" + "fileName": "src/lib/websocket-factory.ts", + "line": 2, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L2" } ], "type": { "type": "intrinsic", - "name": "string" + "name": "number" } }, { - "id": 450, - "name": "channel", + "id": 754, + "name": "dispatchEvent", "variant": "declaration", - "kind": 2048, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 328, + "fileName": "src/lib/websocket-factory.ts", + "line": 25, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" } ], - "signatures": [ - { - "id": 451, - "name": "channel", - "variant": "signature", - "kind": 4096, + "type": { + "type": "reflection", + "declaration": { + "id": 755, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 328, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" } ], - "parameters": [ + "signatures": [ { - "id": 452, - "name": "topic", - "variant": "param", - "kind": 32768, + "id": 756, + "name": "__type", + "variant": "signature", + "kind": 4096, "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "parameters": [ + { + "id": 757, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } - }, - { - "id": 453, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 355, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." } - ], - "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } + ] } - ] + } }, { - "id": 426, - "name": "connect", + "id": 753, + "name": "extensions", "variant": "declaration", - "kind": 2048, - "flags": {}, + "kind": 1024, + "flags": { + "isOptional": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 207, + "fileName": "src/lib/websocket-factory.ts", + "line": 24, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L24" } ], - "signatures": [ + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 733, + "name": "onclose", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ { - "id": 427, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ] + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 207, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + { + "type": "reflection", + "declaration": { + "id": 734, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "signatures": [ + { + "id": 735, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "parameters": [ + { + "id": 736, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 737, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "CloseEvent" + }, + "name": "CloseEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } - ], - "type": { - "type": "intrinsic", - "name": "void" } - } - ] + ] + } }, { - "id": 446, - "name": "connectionState", + "id": 738, + "name": "onerror", "variant": "declaration", - "kind": 2048, + "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 308, + "fileName": "src/lib/websocket-factory.ts", + "line": 16, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" } ], - "signatures": [ - { - "id": 447, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ] + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + { + "type": "reflection", + "declaration": { + "id": 739, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "signatures": [ + { + "id": 740, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "parameters": [ + { + "id": 741, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 742, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "CONNECTION_STATE" - }, - "name": "CONNECTION_STATE", - "package": "@supabase/realtime-js" } - } - ] + ] + } }, { - "id": 430, - "name": "disconnect", + "id": 728, + "name": "onmessage", "variant": "declaration", - "kind": 2048, + "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 244, + "fileName": "src/lib/websocket-factory.ts", + "line": 14, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" } ], - "signatures": [ - { - "id": 431, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ] + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 244, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" - } - ], - "parameters": [ - { - "id": 432, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 433, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." + { + "type": "reflection", + "declaration": { + "id": 729, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "signatures": [ + { + "id": 730, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "parameters": [ + { + "id": 731, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 732, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "MessageEvent" + }, + "name": "MessageEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } + } + ] } - ], - "type": { - "type": "intrinsic", - "name": "void" } - } - ] + ] + } }, { - "id": 428, - "name": "endpointURL", + "id": 723, + "name": "onopen", "variant": "declaration", - "kind": 2048, + "kind": 1024, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 231, + "fileName": "src/lib/websocket-factory.ts", + "line": 13, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" } ], - "signatures": [ - { - "id": 429, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - } - ] + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 231, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + { + "type": "reflection", + "declaration": { + "id": 724, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "signatures": [ + { + "id": 725, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "parameters": [ + { + "id": 726, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 727, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] } - ], - "type": { - "type": "intrinsic", - "name": "string" } - } - ] + ] + } }, { - "id": 468, - "name": "flushSendBuffer", + "id": 710, + "name": "OPEN", "variant": "declaration", - "kind": 2048, - "flags": {}, + "kind": 1024, + "flags": { + "isReadonly": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" + "fileName": "src/lib/websocket-factory.ts", + "line": 3, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L3" } ], - "signatures": [ - { - "id": 469, - "name": "flushSendBuffer", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flushes send buffer" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] + "type": { + "type": "intrinsic", + "name": "number" + } }, { - "id": 434, - "name": "getChannels", + "id": 715, + "name": "protocol", "variant": "declaration", - "kind": 2048, - "flags": {}, + "kind": 1024, + "flags": { + "isReadonly": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 264, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" + "fileName": "src/lib/websocket-factory.ts", + "line": 8, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L8" } ], - "signatures": [ - { - "id": 435, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 264, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 448, - "name": "isConnected", + "id": 713, + "name": "readyState", "variant": "declaration", - "kind": 2048, - "flags": {}, + "kind": 1024, + "flags": { + "isReadonly": true + }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 324, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" + "fileName": "src/lib/websocket-factory.ts", + "line": 6, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L6" } ], - "signatures": [ + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 714, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ { - "id": 449, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 324, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } + "fileName": "src/lib/websocket-factory.ts", + "line": 7, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L7" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 441, - "name": "log", + "id": 743, + "name": "addEventListener", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 301, + "fileName": "src/lib/websocket-factory.ts", + "line": 18, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" } ], "signatures": [ { - "id": 442, - "name": "log", + "id": 744, + "name": "addEventListener", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden." - } - ] - }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 301, + "fileName": "src/lib/websocket-factory.ts", + "line": 18, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" } ], "parameters": [ { - "id": 443, - "name": "kind", + "id": 745, + "name": "type", "variant": "param", "kind": 32768, "flags": {}, @@ -73989,27 +90368,19 @@ } }, { - "id": 444, - "name": "msg", + "id": 746, + "name": "listener", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" } } ], @@ -74021,97 +90392,59 @@ ] }, { - "id": 462, - "name": "onHeartbeat", + "id": 716, + "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 429, + "fileName": "src/lib/websocket-factory.ts", + "line": 10, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" } ], "signatures": [ { - "id": 463, - "name": "onHeartbeat", + "id": 717, + "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 429, + "fileName": "src/lib/websocket-factory.ts", + "line": 10, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" } ], "parameters": [ { - "id": 464, - "name": "callback", + "id": 718, + "name": "code", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "reflection", - "declaration": { - "id": 465, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 429, - "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" - } - ], - "signatures": [ - { - "id": 466, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 429, - "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" - } - ], - "parameters": [ - { - "id": 467, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 719, + "name": "reason", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" } } ], @@ -74123,788 +90456,333 @@ ] }, { - "id": 454, - "name": "push", + "id": 747, + "name": "removeEventListener", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 352, + "fileName": "src/lib/websocket-factory.ts", + "line": 19, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" } ], "signatures": [ { - "id": 455, - "name": "push", + "id": 748, + "name": "removeEventListener", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Push out a message if the socket is connected.\n\nIf the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established." - } - ] - }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 352, + "fileName": "src/lib/websocket-factory.ts", + "line": 19, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" } ], "parameters": [ { - "id": 456, - "name": "data", + "id": 749, + "name": "type", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "reference", - "target": 551, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 439, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 287, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" - } - ], - "signatures": [ - { - "id": 440, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes all channels" + "type": "intrinsic", + "name": "string" } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 287, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 628, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 436, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 272, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" - } - ], - "signatures": [ - { - "id": 437, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes a single channel" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 272, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" - } - ], - "parameters": [ { - "id": 438, - "name": "channel", + "id": 750, + "name": "listener", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, "type": { "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 628, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 460, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 403, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" - } - ], - "signatures": [ - { - "id": 461, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 403, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" } - ], - "name": "Promise", - "package": "typescript" + } + ], + "type": { + "type": "intrinsic", + "name": "void" } } ] }, { - "id": 457, - "name": "setAuth", + "id": 720, + "name": "send", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 376, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" } ], "signatures": [ { - "id": 458, - "name": "setAuth", + "id": 721, + "name": "send", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.\n\nIf param is null it will use the " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client." - } - ] - }, "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 376, - "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" } ], "parameters": [ { - "id": 459, - "name": "token", + "id": 722, + "name": "data", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, "type": { "type": "union", "types": [ - { - "type": "literal", - "value": null - }, { "type": "intrinsic", "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferView" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + } + ], + "name": "ArrayBufferView", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Blob" + }, + "name": "Blob", + "package": "typescript" } ] - }, - "defaultValue": "null" + } } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "void" } } ] } ], "groups": [ - { - "title": "Constructors", - "children": [370] - }, { "title": "Properties", "children": [ - 420, 374, 375, 376, 403, 401, 400, 377, 412, 379, 392, 389, 390, 378, 398, 399, 383, - 391, 402, 397, 396, 404, 405, 406, 387, 388, 423, 425, 424 + 751, 752, 712, 711, 709, 754, 753, 733, 738, 728, 723, 710, 715, 713, 714 ] }, { "title": "Methods", - "children": [ - 450, 426, 446, 430, 428, 468, 434, 448, 441, 462, 454, 439, 436, 460, 457 - ] + "children": [743, 716, 747, 720] } ], "sources": [ { - "fileName": "src/RealtimeClient.ts", - "line": 90, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L90" + "fileName": "src/lib/websocket-factory.ts", + "line": 1, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L1" } ] }, { - "id": 1, - "name": "RealtimePresence", + "id": 758, + "name": "WebSocketLikeConstructor", "variant": "declaration", - "kind": 128, + "kind": 256, "flags": {}, "children": [ { - "id": 30, + "id": 759, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "src/RealtimePresence.ts", - "line": 85, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" } ], "signatures": [ { - "id": 31, - "name": "RealtimePresence", + "id": 760, + "name": "WebSocketLikeConstructor", "variant": "signature", "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Presence." - } - ] - }, "sources": [ { - "fileName": "src/RealtimePresence.ts", - "line": 85, + "fileName": "src/RealtimeClient.ts", + "line": 66, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L66" } ], "parameters": [ { - "id": 32, - "name": "channel", + "id": 761, + "name": "address", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ + "type": { + "type": "union", + "types": [ { - "kind": "text", - "text": "The RealtimeChannel" + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" } ] - }, - "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" } }, { - "id": 33, - "name": "opts", + "id": 762, + "name": "subprotocols", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, - "comment": { - "summary": [ + "type": { + "type": "union", + "types": [ { - "kind": "text", - "text": "The options,\n for example " + "type": "intrinsic", + "name": "string" }, { - "kind": "code", - "text": "`{events: {state: 'state', diff: 'diff'}}`" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/@types/phoenix/index.d.ts", - "qualifiedName": "PresenceOpts" - }, - "name": "PresenceOpts", - "package": "@types/phoenix" } } ], "type": { "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } } ] - }, + } + ], + "groups": [ { - "id": 38, - "name": "caller", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 40, - "name": "onJoin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 69, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L69" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/@types/phoenix/index.d.ts", - "qualifiedName": "PresenceOnJoinCallback" - }, - "name": "PresenceOnJoinCallback", - "package": "@types/phoenix" - } - }, - { - "id": 41, - "name": "onLeave", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 70, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L70" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/@types/phoenix/index.d.ts", - "qualifiedName": "PresenceOnLeaveCallback" - }, - "name": "PresenceOnLeaveCallback", - "package": "@types/phoenix" - } - }, - { - "id": 42, - "name": "onSync", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 71, - "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 71, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" - } - ], - "signatures": [ - { - "id": 44, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 71, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [40, 41, 42] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 68, - "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" - } - ] - } - }, - "defaultValue": "..." - }, + "title": "Constructors", + "children": [759] + } + ], + "sources": [ { - "id": 45, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The RealtimeChannel" - } - ] - }, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 85, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" - } - ], - "type": { - "type": "reference", - "target": 59, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" + } + ], + "indexSignatures": [ { - "id": 37, - "name": "enabled", - "variant": "declaration", - "kind": 1024, + "id": 763, + "name": "__index", + "variant": "signature", + "kind": 8192, "flags": {}, "sources": [ { - "fileName": "src/RealtimePresence.ts", - "line": 67, + "fileName": "src/RealtimeClient.ts", + "line": 71, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L71" } ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 36, - "name": "joinRef", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ + "parameters": [ { - "fileName": "src/RealtimePresence.ts", - "line": 66, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L66" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { + "id": 764, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { "type": "intrinsic", "name": "string" } - ] - }, - "defaultValue": "null" - }, - { - "id": 35, - "name": "pendingDiffs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L65" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RawPresenceDiff" - }, - "name": "RawPresenceDiff", - "package": "@supabase/realtime-js" - } - }, - "defaultValue": "[]" - }, - { - "id": 34, - "name": "state", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 64, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L64" } ], "type": { - "type": "reference", - "target": 619, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [30] - }, - { - "title": "Properties", - "children": [38, 45, 37, 36, 35, 34] - } - ], - "sources": [ - { - "fileName": "src/RealtimePresence.ts", - "line": 63, - "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L63" + "type": "intrinsic", + "name": "any" + } } ] }, { - "id": 355, + "id": 358, "name": "RealtimeChannelOptions", "variant": "declaration", "kind": 2097152, @@ -74912,22 +90790,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 20, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 359, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 357, + "id": 360, "name": "config", "variant": "declaration", "kind": 1024, @@ -74935,22 +90813,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 17, + "line": 21, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" } ], "type": { "type": "reflection", "declaration": { - "id": 358, + "id": 361, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 359, + "id": 362, "name": "broadcast", "variant": "declaration", "kind": 1024, @@ -74968,22 +90846,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 360, + "id": 363, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 362, + "id": 365, "name": "ack", "variant": "declaration", "kind": 1024, @@ -74993,9 +90871,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 34, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -75004,7 +90882,7 @@ } }, { - "id": 361, + "id": 364, "name": "self", "variant": "declaration", "kind": 1024, @@ -75014,9 +90892,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 18, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -75028,22 +90906,22 @@ "groups": [ { "title": "Properties", - "children": [362, 361] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 363, + "id": 366, "name": "presence", "variant": "declaration", "kind": 1024, @@ -75061,22 +90939,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { "type": "reflection", "declaration": { - "id": 364, + "id": 367, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 366, + "id": 369, "name": "enabled", "variant": "declaration", "kind": 1024, @@ -75086,9 +90964,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -75097,7 +90975,7 @@ } }, { - "id": 365, + "id": 368, "name": "key", "variant": "declaration", "kind": 1024, @@ -75107,9 +90985,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -75121,22 +90999,22 @@ "groups": [ { "title": "Properties", - "children": [366, 365] + "children": [369, 368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ] } } }, { - "id": 367, + "id": 370, "name": "private", "variant": "declaration", "kind": 1024, @@ -75154,9 +91032,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 30, + "line": 34, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L34" } ], "type": { @@ -75168,15 +91046,15 @@ "groups": [ { "title": "Properties", - "children": [359, 363, 367] + "children": [362, 366, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 17, + "line": 21, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" } ] } @@ -75186,22 +91064,22 @@ "groups": [ { "title": "Properties", - "children": [357] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 20, "character": 37, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" } ] } } }, { - "id": 368, + "id": 371, "name": "RealtimeChannelSendResponse", "variant": "declaration", "kind": 2097152, @@ -75209,9 +91087,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 92, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L88" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L92" } ], "type": { @@ -75233,7 +91111,7 @@ } }, { - "id": 526, + "id": 564, "name": "RealtimeClientOptions", "variant": "declaration", "kind": 2097152, @@ -75241,22 +91119,22 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 527, + "id": 565, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 548, + "id": 590, "name": "accessToken", "variant": "declaration", "kind": 1024, @@ -75266,15 +91144,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "type": { "type": "reflection", "declaration": { - "id": 549, + "id": 591, "name": "__type", "variant": "declaration", "kind": 65536, @@ -75282,14 +91160,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "signatures": [ { - "id": 550, + "id": 592, "name": "__type", "variant": "signature", "kind": 4096, @@ -75324,7 +91202,7 @@ } }, { - "id": 533, + "id": 575, "name": "decode", "variant": "declaration", "kind": 1024, @@ -75334,9 +91212,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 87, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L70" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L87" } ], "type": { @@ -75350,7 +91228,7 @@ } }, { - "id": 532, + "id": 574, "name": "encode", "variant": "declaration", "kind": 1024, @@ -75360,9 +91238,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 86, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L86" } ], "type": { @@ -75376,7 +91254,7 @@ } }, { - "id": 545, + "id": 587, "name": "fetch", "variant": "declaration", "kind": 1024, @@ -75386,9 +91264,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 94, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L94" } ], "type": { @@ -75402,7 +91280,7 @@ } }, { - "id": 535, + "id": 577, "name": "headers", "variant": "declaration", "kind": 1024, @@ -75412,15 +91290,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "type": { "type": "reflection", "declaration": { - "id": 536, + "id": 578, "name": "__type", "variant": "declaration", "kind": 65536, @@ -75428,14 +91306,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "indexSignatures": [ { - "id": 537, + "id": 579, "name": "__index", "variant": "signature", "kind": 8192, @@ -75443,14 +91321,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "parameters": [ { - "id": 538, + "id": 580, "name": "key", "variant": "param", "kind": 32768, @@ -75471,7 +91349,73 @@ } }, { - "id": 530, + "id": 569, + "name": "heartbeatCallback", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 22, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "signatures": [ + { + "id": 571, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "status", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "HeartbeatStatus" + }, + "name": "HeartbeatStatus", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 568, "name": "heartbeatIntervalMs", "variant": "declaration", "kind": 1024, @@ -75481,9 +91425,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 83, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L83" } ], "type": { @@ -75492,7 +91436,7 @@ } }, { - "id": 543, + "id": 585, "name": "log_level", "variant": "declaration", "kind": 1024, @@ -75502,9 +91446,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 92, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L75" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L92" } ], "type": { @@ -75518,7 +91462,7 @@ } }, { - "id": 531, + "id": 573, "name": "logger", "variant": "declaration", "kind": 1024, @@ -75528,9 +91472,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L85" } ], "type": { @@ -75544,7 +91488,7 @@ } }, { - "id": 544, + "id": 586, "name": "logLevel", "variant": "declaration", "kind": 1024, @@ -75554,9 +91498,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 93, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L76" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L93" } ], "type": { @@ -75570,7 +91514,7 @@ } }, { - "id": 539, + "id": 581, "name": "params", "variant": "declaration", "kind": 1024, @@ -75580,15 +91524,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "type": { "type": "reflection", "declaration": { - "id": 540, + "id": 582, "name": "__type", "variant": "declaration", "kind": 65536, @@ -75596,14 +91540,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "indexSignatures": [ { - "id": 541, + "id": 583, "name": "__index", "variant": "signature", "kind": 8192, @@ -75611,14 +91555,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "parameters": [ { - "id": 542, + "id": 584, "name": "key", "variant": "param", "kind": 32768, @@ -75639,7 +91583,7 @@ } }, { - "id": 534, + "id": 576, "name": "reconnectAfterMs", "variant": "declaration", "kind": 1024, @@ -75649,9 +91593,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 88, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L88" } ], "type": { @@ -75665,7 +91609,7 @@ } }, { - "id": 529, + "id": 567, "name": "timeout", "variant": "declaration", "kind": 1024, @@ -75675,9 +91619,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 82, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L66" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L82" } ], "type": { @@ -75686,7 +91630,7 @@ } }, { - "id": 528, + "id": 566, "name": "transport", "variant": "declaration", "kind": 1024, @@ -75696,23 +91640,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L65" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L81" } ], "type": { "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, + "target": 758, "name": "WebSocketLikeConstructor", "package": "@supabase/realtime-js" } }, { - "id": 546, + "id": 588, "name": "worker", "variant": "declaration", "kind": 1024, @@ -75722,9 +91663,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 95, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L78" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L95" } ], "type": { @@ -75733,7 +91674,7 @@ } }, { - "id": 547, + "id": 589, "name": "workerUrl", "variant": "declaration", "kind": 1024, @@ -75743,9 +91684,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 96, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L79" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L96" } ], "type": { @@ -75758,23 +91699,23 @@ { "title": "Properties", "children": [ - 548, 533, 532, 545, 535, 530, 543, 531, 544, 539, 534, 529, 528, 546, 547 + 590, 575, 574, 587, 577, 569, 568, 585, 573, 586, 581, 576, 567, 566, 588, 589 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 36, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ] } } }, { - "id": 551, + "id": 593, "name": "RealtimeMessage", "variant": "declaration", "kind": 2097152, @@ -75784,20 +91725,20 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 594, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 554, + "id": 596, "name": "event", "variant": "declaration", "kind": 1024, @@ -75807,7 +91748,7 @@ "fileName": "src/RealtimeClient.ts", "line": 33, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L33" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L33" } ], "type": { @@ -75816,7 +91757,7 @@ } }, { - "id": 557, + "id": 599, "name": "join_ref", "variant": "declaration", "kind": 1024, @@ -75828,7 +91769,7 @@ "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L36" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L36" } ], "type": { @@ -75837,7 +91778,7 @@ } }, { - "id": 555, + "id": 597, "name": "payload", "variant": "declaration", "kind": 1024, @@ -75847,7 +91788,7 @@ "fileName": "src/RealtimeClient.ts", "line": 34, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L34" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L34" } ], "type": { @@ -75856,7 +91797,7 @@ } }, { - "id": 556, + "id": 598, "name": "ref", "variant": "declaration", "kind": 1024, @@ -75866,7 +91807,7 @@ "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L35" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L35" } ], "type": { @@ -75875,7 +91816,7 @@ } }, { - "id": 553, + "id": 595, "name": "topic", "variant": "declaration", "kind": 1024, @@ -75885,7 +91826,7 @@ "fileName": "src/RealtimeClient.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L32" } ], "type": { @@ -75897,7 +91838,7 @@ "groups": [ { "title": "Properties", - "children": [554, 557, 555, 556, 553] + "children": [596, 599, 597, 598, 595] } ], "sources": [ @@ -75905,14 +91846,14 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 30, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ] } } }, { - "id": 558, + "id": 600, "name": "RealtimePostgresChangesFilter", "variant": "declaration", "kind": 2097152, @@ -75920,14 +91861,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 67, + "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L71" } ], "typeParameters": [ { - "id": 564, + "id": 606, "name": "T", "variant": "typeParam", "kind": 131072, @@ -75939,7 +91880,7 @@ [ { "type": "reference", - "target": 634, + "target": 676, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "package": "@supabase/realtime-js" }, @@ -75952,14 +91893,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 601, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 560, + "id": 602, "name": "event", "variant": "declaration", "kind": 1024, @@ -75975,21 +91916,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 73, + "line": 77, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L77" } ], "type": { "type": "reference", - "target": 564, + "target": 606, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 563, + "id": 605, "name": "filter", "variant": "declaration", "kind": 1024, @@ -76007,9 +91948,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L89" } ], "type": { @@ -76018,7 +91959,7 @@ } }, { - "id": 561, + "id": 603, "name": "schema", "variant": "declaration", "kind": 1024, @@ -76034,9 +91975,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 77, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L81" } ], "type": { @@ -76045,7 +91986,7 @@ } }, { - "id": 562, + "id": 604, "name": "table", "variant": "declaration", "kind": 1024, @@ -76063,9 +92004,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 81, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L81" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L85" } ], "type": { @@ -76077,22 +92018,22 @@ "groups": [ { "title": "Properties", - "children": [560, 563, 561, 562] + "children": [602, 605, 603, 604] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 69, + "line": 73, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L73" } ] } } }, { - "id": 565, + "id": 607, "name": "RealtimePostgresChangesPayload", "variant": "declaration", "kind": 2097152, @@ -76100,14 +92041,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "typeParameters": [ { - "id": 566, + "id": 608, "name": "T", "variant": "typeParam", "kind": 131072, @@ -76115,7 +92056,7 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 609, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76123,14 +92064,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "indexSignatures": [ { - "id": 568, + "id": 610, "name": "__index", "variant": "signature", "kind": 8192, @@ -76138,14 +92079,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 55, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "parameters": [ { - "id": 569, + "id": 611, "name": "key", "variant": "param", "kind": 32768, @@ -76171,11 +92112,11 @@ "types": [ { "type": "reference", - "target": 570, + "target": 612, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76186,11 +92127,11 @@ }, { "type": "reference", - "target": 580, + "target": 622, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76201,11 +92142,11 @@ }, { "type": "reference", - "target": 589, + "target": 631, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76218,7 +92159,7 @@ } }, { - "id": 589, + "id": 631, "name": "RealtimePostgresDeletePayload", "variant": "declaration", "kind": 2097152, @@ -76226,14 +92167,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "typeParameters": [ { - "id": 595, + "id": 637, "name": "T", "variant": "typeParam", "kind": 131072, @@ -76241,7 +92182,7 @@ "type": { "type": "reflection", "declaration": { - "id": 596, + "id": 638, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76249,14 +92190,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "indexSignatures": [ { - "id": 597, + "id": 639, "name": "__index", "variant": "signature", "kind": 8192, @@ -76264,14 +92205,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "parameters": [ { - "id": 598, + "id": 640, "name": "key", "variant": "param", "kind": 32768, @@ -76307,14 +92248,14 @@ { "type": "reflection", "declaration": { - "id": 590, + "id": 632, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 591, + "id": 633, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -76322,9 +92263,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 61, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L57" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L61" } ], "type": { @@ -76334,7 +92275,7 @@ [ { "type": "reference", - "target": 638, + "target": 680, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", "package": "@supabase/realtime-js" }, @@ -76344,7 +92285,7 @@ } }, { - "id": 592, + "id": 634, "name": "new", "variant": "declaration", "kind": 1024, @@ -76352,15 +92293,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ], "type": { "type": "reflection", "declaration": { - "id": 593, + "id": 635, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76368,16 +92309,16 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ] } } }, { - "id": 594, + "id": 636, "name": "old", "variant": "declaration", "kind": 1024, @@ -76385,9 +92326,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 59, + "line": 63, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L59" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L63" } ], "type": { @@ -76399,7 +92340,7 @@ "typeArguments": [ { "type": "reference", - "target": 595, + "target": 637, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76413,15 +92354,15 @@ "groups": [ { "title": "Properties", - "children": [591, 592, 594] + "children": [633, 634, 636] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 56, + "line": 60, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L56" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L60" } ] } @@ -76430,7 +92371,7 @@ } }, { - "id": 570, + "id": 612, "name": "RealtimePostgresInsertPayload", "variant": "declaration", "kind": 2097152, @@ -76438,14 +92379,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "typeParameters": [ { - "id": 576, + "id": 618, "name": "T", "variant": "typeParam", "kind": 131072, @@ -76453,7 +92394,7 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 619, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76461,14 +92402,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "indexSignatures": [ { - "id": 578, + "id": 620, "name": "__index", "variant": "signature", "kind": 8192, @@ -76476,14 +92417,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "parameters": [ { - "id": 579, + "id": 621, "name": "key", "variant": "param", "kind": 32768, @@ -76519,14 +92460,14 @@ { "type": "reflection", "declaration": { - "id": 571, + "id": 613, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 572, + "id": 614, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -76534,9 +92475,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 43, + "line": 47, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L43" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L47" } ], "type": { @@ -76546,7 +92487,7 @@ [ { "type": "reference", - "target": 636, + "target": 678, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", "package": "@supabase/realtime-js" }, @@ -76556,7 +92497,7 @@ } }, { - "id": 573, + "id": 615, "name": "new", "variant": "declaration", "kind": 1024, @@ -76564,21 +92505,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 48, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L44" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L48" } ], "type": { "type": "reference", - "target": 576, + "target": 618, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 574, + "id": 616, "name": "old", "variant": "declaration", "kind": 1024, @@ -76586,15 +92527,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 617, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76602,9 +92543,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ] } @@ -76614,15 +92555,15 @@ "groups": [ { "title": "Properties", - "children": [572, 573, 574] + "children": [614, 615, 616] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 42, + "line": 46, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L42" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L46" } ] } @@ -76631,7 +92572,7 @@ } }, { - "id": 580, + "id": 622, "name": "RealtimePostgresUpdatePayload", "variant": "declaration", "kind": 2097152, @@ -76639,14 +92580,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "typeParameters": [ { - "id": 585, + "id": 627, "name": "T", "variant": "typeParam", "kind": 131072, @@ -76654,7 +92595,7 @@ "type": { "type": "reflection", "declaration": { - "id": 586, + "id": 628, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76662,14 +92603,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "indexSignatures": [ { - "id": 587, + "id": 629, "name": "__index", "variant": "signature", "kind": 8192, @@ -76677,14 +92618,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "parameters": [ { - "id": 588, + "id": 630, "name": "key", "variant": "param", "kind": 32768, @@ -76720,14 +92661,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 623, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 582, + "id": 624, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -76735,9 +92676,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 54, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L50" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L54" } ], "type": { @@ -76747,7 +92688,7 @@ [ { "type": "reference", - "target": 637, + "target": 679, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", "package": "@supabase/realtime-js" }, @@ -76757,7 +92698,7 @@ } }, { - "id": 583, + "id": 625, "name": "new", "variant": "declaration", "kind": 1024, @@ -76765,21 +92706,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 55, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L51" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L55" } ], "type": { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 584, + "id": 626, "name": "old", "variant": "declaration", "kind": 1024, @@ -76787,9 +92728,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 56, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L52" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L56" } ], "type": { @@ -76801,7 +92742,7 @@ "typeArguments": [ { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76815,15 +92756,15 @@ "groups": [ { "title": "Properties", - "children": [582, 583, 584] + "children": [624, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 49, + "line": 53, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L49" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L53" } ] } @@ -76832,7 +92773,7 @@ } }, { - "id": 599, + "id": 641, "name": "RealtimePresenceJoinPayload", "variant": "declaration", "kind": 2097152, @@ -76842,12 +92783,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "typeParameters": [ { - "id": 605, + "id": 647, "name": "T", "variant": "typeParam", "kind": 131072, @@ -76855,7 +92796,7 @@ "type": { "type": "reflection", "declaration": { - "id": 606, + "id": 648, "name": "__type", "variant": "declaration", "kind": 65536, @@ -76865,12 +92806,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 50, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "indexSignatures": [ { - "id": 607, + "id": 649, "name": "__index", "variant": "signature", "kind": 8192, @@ -76880,12 +92821,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "parameters": [ { - "id": 608, + "id": 650, "name": "key", "variant": "param", "kind": 32768, @@ -76909,14 +92850,14 @@ "type": { "type": "reflection", "declaration": { - "id": 600, + "id": 642, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 603, + "id": 645, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -76926,7 +92867,7 @@ "fileName": "src/RealtimePresence.ts", "line": 24, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L24" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L24" } ], "type": { @@ -76940,7 +92881,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -76952,7 +92893,7 @@ } }, { - "id": 601, + "id": 643, "name": "event", "variant": "declaration", "kind": 1024, @@ -76962,7 +92903,7 @@ "fileName": "src/RealtimePresence.ts", "line": 22, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L22" } ], "type": { @@ -76972,7 +92913,7 @@ [ { "type": "reference", - "target": 641, + "target": 683, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", "package": "@supabase/realtime-js" }, @@ -76982,7 +92923,7 @@ } }, { - "id": 602, + "id": 644, "name": "key", "variant": "declaration", "kind": 1024, @@ -76992,7 +92933,7 @@ "fileName": "src/RealtimePresence.ts", "line": 23, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L23" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L23" } ], "type": { @@ -77001,7 +92942,7 @@ } }, { - "id": 604, + "id": 646, "name": "newPresences", "variant": "declaration", "kind": 1024, @@ -77011,7 +92952,7 @@ "fileName": "src/RealtimePresence.ts", "line": 25, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L25" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L25" } ], "type": { @@ -77025,7 +92966,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -77040,7 +92981,7 @@ "groups": [ { "title": "Properties", - "children": [603, 601, 602, 604] + "children": [645, 643, 644, 646] } ], "sources": [ @@ -77048,14 +92989,14 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 76, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ] } } }, { - "id": 609, + "id": 651, "name": "RealtimePresenceLeavePayload", "variant": "declaration", "kind": 2097152, @@ -77065,12 +93006,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "typeParameters": [ { - "id": 615, + "id": 657, "name": "T", "variant": "typeParam", "kind": 131072, @@ -77078,7 +93019,7 @@ "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 658, "name": "__type", "variant": "declaration", "kind": 65536, @@ -77088,12 +93029,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 51, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "indexSignatures": [ { - "id": 617, + "id": 659, "name": "__index", "variant": "signature", "kind": 8192, @@ -77103,12 +93044,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "parameters": [ { - "id": 618, + "id": 660, "name": "key", "variant": "param", "kind": 32768, @@ -77132,14 +93073,14 @@ "type": { "type": "reflection", "declaration": { - "id": 610, + "id": 652, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 613, + "id": 655, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -77149,7 +93090,7 @@ "fileName": "src/RealtimePresence.ts", "line": 31, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L31" } ], "type": { @@ -77163,7 +93104,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -77175,7 +93116,7 @@ } }, { - "id": 611, + "id": 653, "name": "event", "variant": "declaration", "kind": 1024, @@ -77185,7 +93126,7 @@ "fileName": "src/RealtimePresence.ts", "line": 29, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L29" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L29" } ], "type": { @@ -77195,7 +93136,7 @@ [ { "type": "reference", - "target": 642, + "target": 684, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", "package": "@supabase/realtime-js" }, @@ -77205,7 +93146,7 @@ } }, { - "id": 612, + "id": 654, "name": "key", "variant": "declaration", "kind": 1024, @@ -77215,7 +93156,7 @@ "fileName": "src/RealtimePresence.ts", "line": 30, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L30" } ], "type": { @@ -77224,7 +93165,7 @@ } }, { - "id": 614, + "id": 656, "name": "leftPresences", "variant": "declaration", "kind": 1024, @@ -77234,7 +93175,7 @@ "fileName": "src/RealtimePresence.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L32" } ], "type": { @@ -77248,7 +93189,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -77263,7 +93204,7 @@ "groups": [ { "title": "Properties", - "children": [613, 611, 612, 614] + "children": [655, 653, 654, 656] } ], "sources": [ @@ -77271,14 +93212,14 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 77, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ] } } }, { - "id": 619, + "id": 661, "name": "RealtimePresenceState", "variant": "declaration", "kind": 2097152, @@ -77288,12 +93229,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "typeParameters": [ { - "id": 623, + "id": 665, "name": "T", "variant": "typeParam", "kind": 131072, @@ -77301,7 +93242,7 @@ "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 666, "name": "__type", "variant": "declaration", "kind": 65536, @@ -77311,12 +93252,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 625, + "id": 667, "name": "__index", "variant": "signature", "kind": 8192, @@ -77326,12 +93267,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 46, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "parameters": [ { - "id": 626, + "id": 668, "name": "key", "variant": "param", "kind": 32768, @@ -77353,7 +93294,7 @@ "default": { "type": "reflection", "declaration": { - "id": 627, + "id": 669, "name": "__type", "variant": "declaration", "kind": 65536, @@ -77363,7 +93304,7 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ] } @@ -77373,7 +93314,7 @@ "type": { "type": "reflection", "declaration": { - "id": 620, + "id": 662, "name": "__type", "variant": "declaration", "kind": 65536, @@ -77383,12 +93324,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 621, + "id": 663, "name": "__index", "variant": "signature", "kind": 8192, @@ -77398,12 +93339,12 @@ "fileName": "src/RealtimePresence.ts", "line": 18, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L18" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L18" } ], "parameters": [ { - "id": 622, + "id": 664, "name": "key", "variant": "param", "kind": 32768, @@ -77425,7 +93366,7 @@ "typeArguments": [ { "type": "reference", - "target": 623, + "target": 665, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -77441,7 +93382,7 @@ } }, { - "id": 628, + "id": 670, "name": "RealtimeRemoveChannelResponse", "variant": "declaration", "kind": 2097152, @@ -77451,7 +93392,7 @@ "fileName": "src/RealtimeClient.ts", "line": 39, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L39" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L39" } ], "type": { @@ -77473,7 +93414,7 @@ } }, { - "id": 648, + "id": 690, "name": "REALTIME_CHANNEL_STATES", "variant": "declaration", "kind": 32, @@ -77483,9 +93424,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 111, + "line": 115, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L111" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L115" } ], "type": { @@ -77507,26 +93448,30 @@ "groups": [ { "title": "Enumerations", - "children": [629, 634, 639, 643] + "children": [671, 676, 681, 685] }, { "title": "Classes", - "children": [59, 369, 1] + "children": [59, 372, 1, 691] + }, + { + "title": "Interfaces", + "children": [708, 758] }, { "title": "Type Aliases", - "children": [355, 368, 526, 551, 558, 565, 589, 570, 580, 599, 609, 619, 628] + "children": [358, 371, 564, 593, 600, 607, 631, 612, 622, 641, 651, 661, 670] }, { "title": "Variables", - "children": [648] + "children": [690] } ], "packageName": "@supabase/realtime-js", "readme": [ { "kind": "text", - "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n
\n\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" }, { "kind": "code", @@ -77610,7 +93555,7 @@ }, { "kind": "code", - "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { config: { broadcast: { ack: false, self: false } } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" }, { "kind": "text", @@ -78546,909 +94491,1217 @@ "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "default.teardown" }, - "355": { + "358": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelOptions" }, - "356": { + "359": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "357": { + "360": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.config" }, - "358": { + "361": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "359": { + "362": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.broadcast" }, - "360": { + "363": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "361": { + "364": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.self" }, - "362": { + "365": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.ack" }, - "363": { + "366": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.presence" }, - "364": { + "367": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "365": { + "368": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.key" }, - "366": { + "369": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.enabled" }, - "367": { + "370": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.private" }, - "368": { + "371": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelSendResponse" }, - "369": { + "372": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "370": { + "373": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.__constructor" }, - "371": { + "374": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "372": { + "375": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "endPoint" }, - "373": { + "376": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "options" }, - "374": { + "377": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessTokenValue" }, - "375": { + "378": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.apiKey" }, - "376": { + "379": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channels" }, - "377": { + "380": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endPoint" }, - "378": { + "381": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.httpEndpoint" }, - "379": { + "382": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.headers" }, - "380": { + "383": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "381": { + "384": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "383": { + "386": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.params" }, - "384": { + "387": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "385": { + "388": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "387": { + "390": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.timeout" }, - "388": { + "391": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.transport" }, - "389": { + "392": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatIntervalMs" }, - "390": { + "393": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatTimer" }, - "391": { + "394": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.pendingHeartbeatRef" }, - "392": { + "395": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatCallback" }, - "393": { + "396": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "394": { + "397": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "395": { + "398": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "396": { + "399": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.ref" }, - "397": { + "400": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectTimer" }, - "398": { + "401": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logger" }, - "399": { + "402": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logLevel" }, - "400": { + "403": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.encode" }, - "401": { + "404": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.decode" }, - "402": { + "405": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectAfterMs" }, - "403": { + "406": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.conn" }, - "404": { + "407": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendBuffer" }, - "405": { + "408": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.serializer" }, - "406": { + "409": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.stateChangeCallbacks" }, - "407": { + "410": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "408": { + "411": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.open" }, - "409": { + "412": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.close" }, - "410": { + "413": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.error" }, - "411": { + "414": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.message" }, - "412": { + "415": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.fetch" }, - "413": { + "416": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "414": { + "417": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "415": { + "418": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, - "416": { + "419": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, - "417": { + "420": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, - "418": { + "421": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, - "419": { + "422": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, - "420": { + "423": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessToken" }, - "421": { + "424": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "422": { + "425": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "423": { + "426": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.worker" }, - "424": { + "427": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerUrl" }, - "425": { + "428": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerRef" }, - "426": { + "432": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "427": { + "433": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "428": { + "434": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "429": { + "435": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "430": { + "436": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "431": { + "437": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "432": { + "438": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "code" }, - "433": { + "439": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "reason" }, - "434": { + "440": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "435": { + "441": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "436": { + "442": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "437": { + "443": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "438": { + "444": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "channel" }, - "439": { + "445": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "440": { + "446": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "441": { + "447": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "442": { + "448": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "443": { + "449": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "kind" }, - "444": { + "450": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "msg" }, - "445": { + "451": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "446": { + "452": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "447": { + "453": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "448": { + "454": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "449": { + "455": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "450": { + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "460": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "451": { + "461": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "452": { + "462": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "topic" }, - "453": { + "463": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "params" }, - "454": { + "464": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "455": { + "465": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "456": { + "466": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "457": { + "467": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "458": { + "468": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "459": { + "469": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "token" }, - "460": { + "470": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "461": { + "471": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "462": { + "472": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "463": { + "473": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "464": { + "474": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "callback" }, - "465": { + "475": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "466": { + "476": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "467": { + "477": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "468": { + "478": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "469": { + "479": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "526": { + "564": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeClientOptions" }, - "527": { + "565": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "528": { + "566": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.transport" }, - "529": { + "567": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.timeout" }, - "530": { + "568": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.heartbeatIntervalMs" }, - "531": { + "569": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatCallback" + }, + "570": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "572": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "status" + }, + "573": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logger" }, - "532": { + "574": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.encode" }, - "533": { + "575": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.decode" }, - "534": { + "576": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.reconnectAfterMs" }, - "535": { + "577": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.headers" }, - "536": { + "578": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "537": { + "579": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "539": { + "581": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.params" }, - "540": { + "582": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "541": { + "583": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "543": { + "585": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.log_level" }, - "544": { + "586": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logLevel" }, - "545": { + "587": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.fetch" }, - "546": { + "588": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.worker" }, - "547": { + "589": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.workerUrl" }, - "548": { + "590": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.accessToken" }, - "549": { + "591": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "550": { + "592": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "551": { + "593": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeMessage" }, - "552": { + "594": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "553": { + "595": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.topic" }, - "554": { + "596": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.event" }, - "555": { + "597": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.payload" }, - "556": { + "598": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.ref" }, - "557": { + "599": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.join_ref" }, - "558": { + "600": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesFilter" }, - "559": { + "601": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "560": { + "602": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.event" }, - "561": { + "603": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.schema" }, - "562": { + "604": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.table" }, - "563": { + "605": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.filter" }, - "564": { + "606": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "565": { + "607": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesPayload" }, - "566": { + "608": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "567": { + "609": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "568": { + "610": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "570": { + "612": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresInsertPayload" }, - "571": { + "613": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "572": { + "614": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "573": { + "615": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "574": { + "616": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "575": { + "617": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "576": { + "618": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "577": { + "619": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "578": { + "620": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "580": { + "622": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresUpdatePayload" }, - "581": { + "623": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "582": { + "624": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "583": { + "625": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "584": { + "626": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "585": { + "627": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "586": { + "628": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "587": { + "629": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "589": { + "631": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresDeletePayload" }, - "590": { + "632": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "591": { + "633": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "592": { + "634": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "593": { + "635": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "594": { + "636": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "595": { + "637": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "596": { + "638": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "597": { + "639": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "599": { + "641": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceJoinPayload" }, - "600": { + "642": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "601": { + "643": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "602": { + "644": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "603": { + "645": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "604": { + "646": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.newPresences" }, - "605": { + "647": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "606": { + "648": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "607": { + "649": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "609": { + "651": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceLeavePayload" }, - "610": { + "652": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "611": { + "653": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "612": { + "654": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "613": { + "655": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "614": { + "656": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.leftPresences" }, - "615": { + "657": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "616": { + "658": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "617": { + "659": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "619": { + "661": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceState" }, - "620": { + "662": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "621": { + "663": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "623": { + "665": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "624": { + "666": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "625": { + "667": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "627": { + "669": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "628": { + "670": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeRemoveChannelResponse" }, - "629": { + "671": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES" }, - "630": { + "672": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" }, - "631": { + "673": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" }, - "632": { + "674": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" }, - "633": { + "675": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" }, - "634": { + "676": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, - "635": { + "677": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" }, - "636": { + "678": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, - "637": { + "679": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, - "638": { + "680": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, - "639": { + "681": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" }, - "640": { + "682": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" }, - "641": { + "683": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, - "642": { + "684": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, - "643": { + "685": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES" }, - "644": { + "686": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" }, - "645": { + "687": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" }, - "646": { + "688": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" }, - "647": { + "689": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" }, - "648": { + "690": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_CHANNEL_STATES" + }, + "691": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory" + }, + "694": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "695": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "696": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "697": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "698": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "url" + }, + "699": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "protocols" + }, + "700": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "701": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "702": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "url" + }, + "703": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "protocols" + }, + "704": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "705": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "708": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike" + }, + "709": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CONNECTING" + }, + "710": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.OPEN" + }, + "711": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSING" + }, + "712": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSED" + }, + "713": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.readyState" + }, + "714": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.url" + }, + "715": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.protocol" + }, + "716": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "717": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "718": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "code" + }, + "719": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "reason" + }, + "720": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "721": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "722": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "data" + }, + "723": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onopen" + }, + "724": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "725": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "726": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "727": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "728": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onmessage" + }, + "729": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "730": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "731": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "732": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "733": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onclose" + }, + "734": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "735": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "736": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "737": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "738": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onerror" + }, + "739": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "740": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "741": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "742": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "743": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "744": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "745": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "746": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "747": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "748": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "749": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "750": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "751": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.binaryType" + }, + "752": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.bufferedAmount" + }, + "753": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.extensions" + }, + "754": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.dispatchEvent" + }, + "755": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "756": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "757": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "event" + }, + "758": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "759": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "760": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "761": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "address" + }, + "762": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "subprotocols" + }, + "763": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor.__index" } }, "files": { @@ -79475,14 +95728,14 @@ "flags": {}, "children": [ { - "id": 504, + "id": 534, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 505, + "id": 535, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -79491,19 +95744,20 @@ { "fileName": "src/lib/errors.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 506, + "id": 536, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 537, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -79514,7 +95768,7 @@ } }, { - "id": 508, + "id": 538, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -79525,7 +95779,7 @@ } }, { - "id": 509, + "id": 539, "name": "statusCode", "kind": 32768, "kindString": "Parameter", @@ -79538,24 +95792,24 @@ ], "type": { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 510, + "id": 540, "name": "status", "kind": 1024, "kindString": "Property", @@ -79564,7 +95818,8 @@ { "fileName": "src/lib/errors.ts", "line": 15, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L15" } ], "type": { @@ -79573,7 +95828,7 @@ } }, { - "id": 511, + "id": 541, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -79582,7 +95837,8 @@ { "fileName": "src/lib/errors.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L16" } ], "type": { @@ -79591,7 +95847,7 @@ } }, { - "id": 512, + "id": 542, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -79600,12 +95856,13 @@ { "fileName": "src/lib/errors.ts", "line": 25, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L25" } ], "signatures": [ { - "id": 513, + "id": 543, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -79613,14 +95870,14 @@ "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 546, "name": "message", "kind": 1024, "kindString": "Property", @@ -79629,7 +95886,8 @@ { "fileName": "src/lib/errors.ts", "line": 28, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L28" } ], "type": { @@ -79639,7 +95897,7 @@ "defaultValue": "..." }, { - "id": 515, + "id": 545, "name": "name", "kind": 1024, "kindString": "Property", @@ -79648,7 +95906,8 @@ { "fileName": "src/lib/errors.ts", "line": 27, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L27" } ], "type": { @@ -79658,7 +95917,7 @@ "defaultValue": "..." }, { - "id": 517, + "id": 547, "name": "status", "kind": 1024, "kindString": "Property", @@ -79667,7 +95926,8 @@ { "fileName": "src/lib/errors.ts", "line": 29, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L29" } ], "type": { @@ -79677,7 +95937,7 @@ "defaultValue": "..." }, { - "id": 518, + "id": 548, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -79686,7 +95946,8 @@ { "fileName": "src/lib/errors.ts", "line": 30, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L30" } ], "type": { @@ -79699,8 +95960,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [516, 515, 517, 518] + "children": [546, 545, 547, 548] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L26" } ] } @@ -79712,44 +95980,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [505] + "children": [535] }, { "title": "Properties", - "kind": 1024, - "children": [510, 511] + "children": [540, 541] }, { "title": "Methods", - "kind": 2048, - "children": [512] + "children": [542] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L14" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 335, + "id": 351, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 336, + "id": 352, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -79758,19 +96024,20 @@ { "fileName": "src/StorageClient.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L10" } ], "signatures": [ { - "id": 337, + "id": 353, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 338, + "id": 354, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -79781,7 +96048,7 @@ } }, { - "id": 339, + "id": 355, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -79789,20 +96056,28 @@ "type": { "type": "reflection", "declaration": { - "id": 340, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 12, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L12" + } + ], "indexSignature": { - "id": 341, + "id": 357, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 342, + "id": 358, "name": "key", "kind": 32768, "flags": {}, @@ -79822,7 +96097,7 @@ "defaultValue": "{}" }, { - "id": 343, + "id": 359, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -79832,34 +96107,41 @@ "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 345, + "id": 361, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 346, + "id": 362, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 347, + "id": 363, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -79868,9 +96150,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -79879,14 +96161,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -79894,7 +96176,7 @@ } }, { - "id": 348, + "id": 364, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -79909,7 +96191,7 @@ ], "type": { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" }, "overwrites": { @@ -79926,7 +96208,7 @@ } }, { - "id": 379, + "id": 398, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -79934,30 +96216,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 380, + "id": 399, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 381, + "id": 400, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -79965,7 +96268,7 @@ } }, { - "id": 382, + "id": 401, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -79973,14 +96276,14 @@ "type": { "type": "reflection", "declaration": { - "id": 383, + "id": 402, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 405, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -79988,13 +96291,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -80015,7 +96324,7 @@ } }, { - "id": 385, + "id": 404, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -80023,13 +96332,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -80051,19 +96366,25 @@ } }, { - "id": 384, + "id": 403, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -80072,7 +96393,7 @@ } }, { - "id": 387, + "id": 406, "name": "type", "kind": 1024, "kindString": "Property", @@ -80080,21 +96401,39 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -80103,7 +96442,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -80126,8 +96466,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [386, 385, 384, 387] + "children": [405, 404, 403, 406] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -80144,14 +96491,14 @@ { "type": "reflection", "declaration": { - "id": 388, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 408, "name": "data", "kind": 1024, "kindString": "Property", @@ -80159,8 +96506,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -80168,7 +96516,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -80176,13 +96524,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 390, + "id": 409, "name": "error", "kind": 1024, "kindString": "Property", @@ -80190,8 +96538,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -80203,8 +96552,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [389, 390] + "children": [408, 409] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -80212,14 +96568,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 411, "name": "data", "kind": 1024, "kindString": "Property", @@ -80227,8 +96583,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -80237,7 +96594,7 @@ } }, { - "id": 393, + "id": 412, "name": "error", "kind": 1024, "kindString": "Property", @@ -80245,13 +96602,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -80259,8 +96617,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [392, 393] + "children": [411, 412] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -80268,25 +96633,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 48, "name": "default.createBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 44, + "id": 47, "name": "default.createBucket" } }, { - "id": 421, + "id": 440, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -80294,29 +96659,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 422, + "id": 441, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 423, + "id": 442, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -80333,14 +96717,14 @@ { "type": "reflection", "declaration": { - "id": 424, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 425, + "id": 444, "name": "data", "kind": 1024, "kindString": "Property", @@ -80348,21 +96732,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 445, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 446, "name": "message", "kind": 1024, "kindString": "Property", @@ -80370,8 +96755,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -80383,15 +96769,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [427] + "children": [446] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 428, + "id": 447, "name": "error", "kind": 1024, "kindString": "Property", @@ -80399,8 +96792,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -80412,8 +96806,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [425, 428] + "children": [444, 447] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -80421,14 +96822,14 @@ { "type": "reflection", "declaration": { - "id": 429, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 430, + "id": 449, "name": "data", "kind": 1024, "kindString": "Property", @@ -80436,8 +96837,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -80446,7 +96848,7 @@ } }, { - "id": 431, + "id": 450, "name": "error", "kind": 1024, "kindString": "Property", @@ -80454,13 +96856,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -80468,8 +96871,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [430, 431] + "children": [449, 450] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -80477,25 +96887,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 87, + "id": 90, "name": "default.deleteBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 86, + "id": 89, "name": "default.deleteBucket" } }, { - "id": 410, + "id": 429, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -80503,29 +96913,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 411, + "id": 430, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 412, + "id": 431, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -80542,14 +96963,14 @@ { "type": "reflection", "declaration": { - "id": 413, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 414, + "id": 433, "name": "data", "kind": 1024, "kindString": "Property", @@ -80557,21 +96978,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 435, "name": "message", "kind": 1024, "kindString": "Property", @@ -80579,8 +97001,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -80592,15 +97015,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [416] + "children": [435] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 417, + "id": 436, "name": "error", "kind": 1024, "kindString": "Property", @@ -80608,8 +97038,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -80621,8 +97052,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [414, 417] + "children": [433, 436] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -80630,14 +97068,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 437, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 438, "name": "data", "kind": 1024, "kindString": "Property", @@ -80645,8 +97083,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -80655,7 +97094,7 @@ } }, { - "id": 420, + "id": 439, "name": "error", "kind": 1024, "kindString": "Property", @@ -80663,13 +97102,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -80677,8 +97117,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [419, 420] + "children": [438, 439] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -80686,25 +97133,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 76, + "id": 79, "name": "default.emptyBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 75, + "id": 78, "name": "default.emptyBucket" } }, { - "id": 349, + "id": 365, "name": "from", "kind": 2048, "kindString": "Method", @@ -80713,28 +97160,39 @@ { "fileName": "src/StorageClient.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L24" } ], "signatures": [ { - "id": 350, + "id": 366, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform file operation in a bucket." + "summary": [ + { + "kind": "text", + "text": "Perform file operation in a bucket." + } + ] }, "parameters": [ { - "id": 351, + "id": 367, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The bucket id to operate on.\n" + "summary": [ + { + "kind": "text", + "text": "The bucket id to operate on." + } + ] }, "type": { "type": "intrinsic", @@ -80744,14 +97202,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 370, + "id": 389, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -80759,29 +97217,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 371, + "id": 390, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 372, + "id": 391, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -80798,14 +97267,14 @@ { "type": "reflection", "declaration": { - "id": 373, + "id": 392, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 374, + "id": 393, "name": "data", "kind": 1024, "kindString": "Property", @@ -80813,18 +97282,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 375, + "id": 394, "name": "error", "kind": 1024, "kindString": "Property", @@ -80832,8 +97302,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -80845,8 +97316,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [374, 375] + "children": [393, 394] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -80854,14 +97332,14 @@ { "type": "reflection", "declaration": { - "id": 376, + "id": 395, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 377, + "id": 396, "name": "data", "kind": 1024, "kindString": "Property", @@ -80869,8 +97347,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -80879,7 +97358,7 @@ } }, { - "id": 378, + "id": 397, "name": "error", "kind": 1024, "kindString": "Property", @@ -80887,13 +97366,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -80901,8 +97381,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [377, 378] + "children": [396, 397] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -80910,25 +97397,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 36, + "id": 39, "name": "default.getBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 35, + "id": 38, "name": "default.getBucket" } }, { - "id": 362, + "id": 381, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -80936,19 +97423,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 363, + "id": 382, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -80959,14 +97452,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 384, "name": "data", "kind": 1024, "kindString": "Property", @@ -80974,21 +97467,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 366, + "id": 385, "name": "error", "kind": 1024, "kindString": "Property", @@ -80996,8 +97490,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -81009,8 +97504,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 366] + "children": [384, 385] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -81018,14 +97520,14 @@ { "type": "reflection", "declaration": { - "id": 367, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 387, "name": "data", "kind": 1024, "kindString": "Property", @@ -81033,8 +97535,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -81043,7 +97546,7 @@ } }, { - "id": 369, + "id": 388, "name": "error", "kind": 1024, "kindString": "Property", @@ -81051,13 +97554,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -81065,8 +97569,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368, 369] + "children": [387, 388] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -81074,25 +97585,74 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 28, + "id": 31, "name": "default.listBuckets" } } ], "inheritedFrom": { "type": "reference", - "id": 27, + "id": 30, "name": "default.listBuckets" } }, { - "id": 394, + "id": 379, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 380, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 351, + "name": "StorageClient" + }, + "inheritedFrom": { + "type": "reference", + "id": 29, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 28, + "name": "default.throwOnError" + } + }, + { + "id": 413, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -81100,29 +97660,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 395, + "id": 414, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 396, + "id": 415, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -81130,7 +97701,7 @@ } }, { - "id": 397, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -81138,14 +97709,14 @@ "type": { "type": "reflection", "declaration": { - "id": 398, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 401, + "id": 420, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -81153,13 +97724,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -81180,7 +97757,7 @@ } }, { - "id": 400, + "id": 419, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -81188,13 +97765,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -81216,19 +97799,25 @@ } }, { - "id": 399, + "id": 418, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -81240,8 +97829,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [401, 400, 399] + "children": [420, 419, 418] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -81257,14 +97853,14 @@ { "type": "reflection", "declaration": { - "id": 402, + "id": 421, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 403, + "id": 422, "name": "data", "kind": 1024, "kindString": "Property", @@ -81272,21 +97868,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 405, + "id": 424, "name": "message", "kind": 1024, "kindString": "Property", @@ -81294,8 +97891,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -81307,15 +97905,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [405] + "children": [424] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 406, + "id": 425, "name": "error", "kind": 1024, "kindString": "Property", @@ -81323,8 +97928,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -81336,8 +97942,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [403, 406] + "children": [422, 425] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -81345,14 +97958,14 @@ { "type": "reflection", "declaration": { - "id": 407, + "id": 426, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 408, + "id": 427, "name": "data", "kind": 1024, "kindString": "Property", @@ -81360,8 +97973,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -81370,7 +97984,7 @@ } }, { - "id": 409, + "id": 428, "name": "error", "kind": 1024, "kindString": "Property", @@ -81378,13 +97992,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -81392,8 +98007,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [408, 409] + "children": [427, 428] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -81401,20 +98023,20 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 60, + "id": 63, "name": "default.updateBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 59, + "id": 62, "name": "default.updateBucket" } } @@ -81422,20 +98044,19 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [336] + "children": [352] }, { "title": "Methods", - "kind": 2048, - "children": [379, 421, 410, 349, 370, 362, 394] + "children": [398, 440, 429, 365, 389, 381, 379, 413] } ], "sources": [ { "fileName": "src/StorageClient.ts", "line": 9, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L9" } ], "extendedTypes": [ @@ -81447,14 +98068,14 @@ ] }, { - "id": 499, + "id": 529, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 500, + "id": 530, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -81463,19 +98084,20 @@ { "fileName": "src/lib/errors.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L4" } ], "signatures": [ { - "id": 501, + "id": 531, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 502, + "id": 532, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -81488,7 +98110,7 @@ ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" }, "overwrites": { @@ -81506,47 +98128,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [500] + "children": [530] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 1, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L1" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ], "extendedBy": [ { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" } ] }, { - "id": 520, + "id": 550, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 521, + "id": 551, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -81555,19 +98177,20 @@ { "fileName": "src/lib/errors.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L38" } ], "signatures": [ { - "id": 522, + "id": 552, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 523, + "id": 553, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -81578,7 +98201,7 @@ } }, { - "id": 524, + "id": 554, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -81591,24 +98214,24 @@ ], "type": { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 525, + "id": 555, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -81617,7 +98240,8 @@ { "fileName": "src/lib/errors.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L36" } ], "type": { @@ -81629,39 +98253,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [521] + "children": [551] }, { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [555] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 35, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L35" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 433, + "id": 452, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 439, + "id": 458, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -81672,7 +98295,8 @@ { "fileName": "src/lib/types.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L9" } ], "type": { @@ -81684,7 +98308,7 @@ } }, { - "id": 440, + "id": 459, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -81693,7 +98317,8 @@ { "fileName": "src/lib/types.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L10" } ], "type": { @@ -81702,7 +98327,7 @@ } }, { - "id": 438, + "id": 457, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -81713,7 +98338,8 @@ { "fileName": "src/lib/types.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L8" } ], "type": { @@ -81722,7 +98348,7 @@ } }, { - "id": 434, + "id": 453, "name": "id", "kind": 1024, "kindString": "Property", @@ -81731,7 +98357,8 @@ { "fileName": "src/lib/types.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L4" } ], "type": { @@ -81740,7 +98367,7 @@ } }, { - "id": 436, + "id": 455, "name": "name", "kind": 1024, "kindString": "Property", @@ -81749,7 +98376,8 @@ { "fileName": "src/lib/types.ts", "line": 6, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L6" } ], "type": { @@ -81758,7 +98386,7 @@ } }, { - "id": 437, + "id": 456, "name": "owner", "kind": 1024, "kindString": "Property", @@ -81767,7 +98395,8 @@ { "fileName": "src/lib/types.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L7" } ], "type": { @@ -81776,7 +98405,7 @@ } }, { - "id": 442, + "id": 461, "name": "public", "kind": 1024, "kindString": "Property", @@ -81785,7 +98414,8 @@ { "fileName": "src/lib/types.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L12" } ], "type": { @@ -81794,7 +98424,7 @@ } }, { - "id": 435, + "id": 454, "name": "type", "kind": 1024, "kindString": "Property", @@ -81805,15 +98435,16 @@ { "fileName": "src/lib/types.ts", "line": 5, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L5" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -81822,7 +98453,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -81842,7 +98474,7 @@ } }, { - "id": 441, + "id": 460, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -81851,7 +98483,8 @@ { "fileName": "src/lib/types.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L11" } ], "type": { @@ -81863,27 +98496,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 440, 438, 434, 436, 437, 442, 435, 441] + "children": [458, 459, 457, 453, 455, 456, 461, 454, 460] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L3" } ] }, { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -81894,7 +98527,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -81906,27 +98540,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] }, { - "id": 484, + "id": 514, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 485, + "id": 515, "name": "signal", "kind": 1024, "kindString": "Property", @@ -81934,47 +98568,53 @@ "isOptional": true }, "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [485] + "children": [515] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, - "character": 17 + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" } ] }, { - "id": 443, + "id": 462, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 445, + "id": 464, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -81983,7 +98623,8 @@ { "fileName": "src/lib/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L17" } ], "type": { @@ -81992,7 +98633,7 @@ } }, { - "id": 452, + "id": 471, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -82001,22 +98642,23 @@ { "fileName": "src/lib/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L24" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket", "dereferenced": { - "id": 433, + "id": 452, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 439, + "id": 458, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -82027,7 +98669,8 @@ { "fileName": "src/lib/types.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L9" } ], "type": { @@ -82039,7 +98682,7 @@ } }, { - "id": 440, + "id": 459, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -82048,7 +98691,8 @@ { "fileName": "src/lib/types.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L10" } ], "type": { @@ -82057,7 +98701,7 @@ } }, { - "id": 438, + "id": 457, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -82068,7 +98712,8 @@ { "fileName": "src/lib/types.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L8" } ], "type": { @@ -82077,7 +98722,7 @@ } }, { - "id": 434, + "id": 453, "name": "id", "kind": 1024, "kindString": "Property", @@ -82086,7 +98731,8 @@ { "fileName": "src/lib/types.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L4" } ], "type": { @@ -82095,7 +98741,7 @@ } }, { - "id": 436, + "id": 455, "name": "name", "kind": 1024, "kindString": "Property", @@ -82104,7 +98750,8 @@ { "fileName": "src/lib/types.ts", "line": 6, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L6" } ], "type": { @@ -82113,7 +98760,7 @@ } }, { - "id": 437, + "id": 456, "name": "owner", "kind": 1024, "kindString": "Property", @@ -82122,7 +98769,8 @@ { "fileName": "src/lib/types.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L7" } ], "type": { @@ -82131,7 +98779,7 @@ } }, { - "id": 442, + "id": 461, "name": "public", "kind": 1024, "kindString": "Property", @@ -82140,7 +98788,8 @@ { "fileName": "src/lib/types.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L12" } ], "type": { @@ -82149,7 +98798,7 @@ } }, { - "id": 435, + "id": 454, "name": "type", "kind": 1024, "kindString": "Property", @@ -82160,15 +98809,16 @@ { "fileName": "src/lib/types.ts", "line": 5, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L5" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -82177,7 +98827,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -82197,7 +98848,7 @@ } }, { - "id": 441, + "id": 460, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -82206,7 +98857,8 @@ { "fileName": "src/lib/types.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L11" } ], "type": { @@ -82218,22 +98870,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 440, 438, 434, 436, 437, 442, 435, 441] + "children": [458, 459, 457, 453, 455, 456, 461, 454, 460] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L3" } ] } } }, { - "id": 449, + "id": 468, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -82242,7 +98894,8 @@ { "fileName": "src/lib/types.ts", "line": 21, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L21" } ], "type": { @@ -82251,7 +98904,7 @@ } }, { - "id": 447, + "id": 466, "name": "id", "kind": 1024, "kindString": "Property", @@ -82260,7 +98913,8 @@ { "fileName": "src/lib/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L19" } ], "type": { @@ -82269,7 +98923,7 @@ } }, { - "id": 450, + "id": 469, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -82278,7 +98932,8 @@ { "fileName": "src/lib/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L22" } ], "type": { @@ -82287,7 +98942,7 @@ } }, { - "id": 451, + "id": 470, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -82296,7 +98951,8 @@ { "fileName": "src/lib/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L23" } ], "type": { @@ -82311,13 +98967,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 444, + "id": 463, "name": "name", "kind": 1024, "kindString": "Property", @@ -82326,7 +98982,8 @@ { "fileName": "src/lib/types.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L16" } ], "type": { @@ -82335,7 +98992,7 @@ } }, { - "id": 446, + "id": 465, "name": "owner", "kind": 1024, "kindString": "Property", @@ -82344,7 +99001,8 @@ { "fileName": "src/lib/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L18" } ], "type": { @@ -82353,7 +99011,7 @@ } }, { - "id": 448, + "id": 467, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -82362,7 +99020,8 @@ { "fileName": "src/lib/types.ts", "line": 20, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L20" } ], "type": { @@ -82374,27 +99033,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [445, 452, 449, 447, 450, 451, 444, 446, 448] + "children": [464, 471, 468, 466, 469, 470, 463, 465, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L15" } ] }, { - "id": 453, + "id": 472, "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 457, + "id": 476, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -82403,7 +99062,8 @@ { "fileName": "src/lib/types.ts", "line": 31, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L31" } ], "type": { @@ -82412,7 +99072,7 @@ } }, { - "id": 462, + "id": 481, "name": "cache_control", "kind": 1024, "kindString": "Property", @@ -82423,7 +99083,8 @@ { "fileName": "src/lib/types.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L36" } ], "type": { @@ -82432,7 +99093,7 @@ } }, { - "id": 463, + "id": 482, "name": "content_type", "kind": 1024, "kindString": "Property", @@ -82443,7 +99104,8 @@ { "fileName": "src/lib/types.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L37" } ], "type": { @@ -82452,7 +99114,7 @@ } }, { - "id": 459, + "id": 478, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -82461,7 +99123,8 @@ { "fileName": "src/lib/types.ts", "line": 33, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L33" } ], "type": { @@ -82470,7 +99133,7 @@ } }, { - "id": 464, + "id": 483, "name": "etag", "kind": 1024, "kindString": "Property", @@ -82481,7 +99144,8 @@ { "fileName": "src/lib/types.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L38" } ], "type": { @@ -82490,7 +99154,7 @@ } }, { - "id": 454, + "id": 473, "name": "id", "kind": 1024, "kindString": "Property", @@ -82499,7 +99163,8 @@ { "fileName": "src/lib/types.ts", "line": 28, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L28" } ], "type": { @@ -82508,7 +99173,7 @@ } }, { - "id": 460, + "id": 479, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -82517,7 +99182,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L34" } ], "type": { @@ -82526,7 +99192,7 @@ } }, { - "id": 465, + "id": 484, "name": "last_modified", "kind": 1024, "kindString": "Property", @@ -82537,7 +99203,8 @@ { "fileName": "src/lib/types.ts", "line": 39, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L39" } ], "type": { @@ -82546,7 +99213,7 @@ } }, { - "id": 466, + "id": 485, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -82557,7 +99224,8 @@ { "fileName": "src/lib/types.ts", "line": 40, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L40" } ], "type": { @@ -82572,13 +99240,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 456, + "id": 475, "name": "name", "kind": 1024, "kindString": "Property", @@ -82587,7 +99255,8 @@ { "fileName": "src/lib/types.ts", "line": 30, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L30" } ], "type": { @@ -82596,7 +99265,7 @@ } }, { - "id": 461, + "id": 480, "name": "size", "kind": 1024, "kindString": "Property", @@ -82607,7 +99276,8 @@ { "fileName": "src/lib/types.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L35" } ], "type": { @@ -82616,7 +99286,7 @@ } }, { - "id": 458, + "id": 477, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -82625,7 +99295,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L32" } ], "type": { @@ -82634,7 +99305,7 @@ } }, { - "id": 455, + "id": 474, "name": "version", "kind": 1024, "kindString": "Property", @@ -82643,7 +99314,8 @@ { "fileName": "src/lib/types.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L29" } ], "type": { @@ -82655,27 +99327,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [457, 462, 463, 459, 464, 454, 460, 465, 466, 456, 461, 458, 455] + "children": [476, 481, 482, 478, 483, 473, 479, 484, 485, 475, 480, 477, 474] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 27, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L27" } ] }, { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -82683,13 +99355,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -82698,7 +99384,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -82706,13 +99392,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -82721,7 +99461,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -82729,13 +99469,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -82744,7 +99490,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -82752,13 +99498,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -82773,13 +99525,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -82787,13 +99539,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -82808,13 +99566,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -82822,13 +99580,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -82840,27 +99604,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] }, { - "id": 486, + "id": 516, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 487, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -82868,8 +99632,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 + "line": 126, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L126" } ], "type": { @@ -82881,27 +99646,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [487] + "children": [517] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 17 + "line": 125, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L125" } ] }, { - "id": 479, + "id": 498, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 480, + "id": 499, "name": "limit", "kind": 1024, "kindString": "Property", @@ -82909,11 +99674,21 @@ "isOptional": true }, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "The number of files you want to be returned." + } + ], + "blockTags": [ { - "tag": "default", - "text": "100\n" + "tag": "@default", + "content": [ + { + "kind": "text", + "text": "100" + } + ] } ] }, @@ -82921,7 +99696,8 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L86" } ], "type": { @@ -82930,7 +99706,7 @@ } }, { - "id": 481, + "id": 500, "name": "offset", "kind": 1024, "kindString": "Property", @@ -82938,13 +99714,19 @@ "isOptional": true }, "comment": { - "shortText": "The starting position." + "summary": [ + { + "kind": "text", + "text": "The starting position." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L91" } ], "type": { @@ -82953,7 +99735,7 @@ } }, { - "id": 483, + "id": 502, "name": "search", "kind": 1024, "kindString": "Property", @@ -82961,13 +99743,19 @@ "isOptional": true }, "comment": { - "shortText": "The search string to filter files by." + "summary": [ + { + "kind": "text", + "text": "The search string to filter files by." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L101" } ], "type": { @@ -82976,7 +99764,7 @@ } }, { - "id": 482, + "id": 501, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -82984,28 +99772,34 @@ "isOptional": true }, "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." + "summary": [ + { + "kind": "text", + "text": "The column to sort by. Can be any column inside a FileObject." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 96, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L96" } ], "type": { "type": "reference", - "id": 467, + "id": 486, "name": "SortBy", "dereferenced": { - "id": 467, + "id": 486, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, + "id": 487, "name": "column", "kind": 1024, "kindString": "Property", @@ -83016,7 +99810,8 @@ { "fileName": "src/lib/types.ts", "line": 44, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" } ], "type": { @@ -83025,7 +99820,7 @@ } }, { - "id": 469, + "id": 488, "name": "order", "kind": 1024, "kindString": "Property", @@ -83036,7 +99831,8 @@ { "fileName": "src/lib/types.ts", "line": 45, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" } ], "type": { @@ -83048,15 +99844,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [487, 488] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 43, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" } ] } @@ -83066,27 +99862,262 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [480, 481, 483, 482] + "children": [499, 500, 502, 501] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 81, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L81" } ] }, { - "id": 467, + "id": 503, + "name": "SearchV2Options", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 506, + "name": "cursor", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L107" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 504, + "name": "limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L105" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 505, + "name": "prefix", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L106" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 507, + "name": "with_delimiter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L108" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [506, 504, 505, 507] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L104" + } + ] + }, + { + "id": 508, + "name": "SearchV2Result", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 510, + "name": "folders", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 512, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [512] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ] + } + } + } + }, + { + "id": 509, + "name": "hasNext", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L112" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 513, + "name": "objects", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L114" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 462, + "name": "FileObject" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [510, 509, 513] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L111" + } + ] + }, + { + "id": 486, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, + "id": 487, "name": "column", "kind": 1024, "kindString": "Property", @@ -83097,7 +100128,8 @@ { "fileName": "src/lib/types.ts", "line": 44, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" } ], "type": { @@ -83106,7 +100138,7 @@ } }, { - "id": 469, + "id": 488, "name": "order", "kind": 1024, "kindString": "Property", @@ -83117,7 +100149,8 @@ { "fileName": "src/lib/types.ts", "line": 45, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" } ], "type": { @@ -83129,27 +100162,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [487, 488] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 43, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" } ] }, { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -83157,14 +100190,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -83173,7 +100211,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -83181,13 +100219,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -83196,7 +100240,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -83204,13 +100248,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -83219,7 +100269,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -83227,13 +100277,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -83255,7 +100311,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -83263,13 +100319,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -83281,20 +100343,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] }, { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -83303,7 +100365,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -83321,7 +100384,7 @@ } }, { - "id": 494, + "id": 524, "name": "Camelize", "kind": 4194304, "kindString": "Type alias", @@ -83329,13 +100392,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 151, - "character": 12 + "line": 164, + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L164" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 495, + "id": 525, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -83350,7 +100414,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -83362,7 +100426,7 @@ }, "objectType": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -83381,9 +100445,9 @@ "name": "string" } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } ], "name": "CamelCase" @@ -83391,7 +100455,7 @@ } }, { - "id": 496, + "id": 526, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -83400,19 +100464,20 @@ { "fileName": "src/lib/errors.ts", "line": 10, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L10" } ], "signatures": [ { - "id": 497, + "id": 527, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 528, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -83429,7 +100494,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -83440,30 +100505,27 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [504, 335, 499, 520] + "children": [534, 351, 529, 550] }, { "title": "Interfaces", - "kind": 256, - "children": [433, 477, 484, 443, 453, 470, 486, 479, 467, 488] + "children": [452, 496, 514, 462, 472, 489, 516, 498, 503, 508, 486, 518] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [432, 494] + "children": [451, 524] }, { "title": "Functions", - "kind": 64, - "children": [496] + "children": [526] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/index.ts#L1" } ] }, @@ -83490,8 +100552,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 13, - "character": 2 + "line": 14, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L14" } ], "signatures": [ @@ -83527,6 +100590,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 16, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L16" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -83570,6 +100641,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -83586,9 +100664,9 @@ "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { @@ -83601,9 +100679,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -83612,14 +100690,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -83649,7 +100727,7 @@ ] }, { - "id": 44, + "id": 47, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -83657,30 +100735,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 45, + "id": 48, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 46, + "id": 49, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -83688,7 +100787,7 @@ } }, { - "id": 47, + "id": 50, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -83696,14 +100795,14 @@ "type": { "type": "reflection", "declaration": { - "id": 48, + "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 51, + "id": 54, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -83711,13 +100810,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -83738,7 +100843,7 @@ } }, { - "id": 50, + "id": 53, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -83746,13 +100851,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -83774,19 +100885,25 @@ } }, { - "id": 49, + "id": 52, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -83795,7 +100912,7 @@ } }, { - "id": 52, + "id": 55, "name": "type", "kind": 1024, "kindString": "Property", @@ -83803,21 +100920,39 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -83826,7 +100961,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -83849,8 +100985,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [51, 50, 49, 52] + "children": [54, 53, 52, 55] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -83867,14 +101010,14 @@ { "type": "reflection", "declaration": { - "id": 53, + "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 57, "name": "data", "kind": 1024, "kindString": "Property", @@ -83882,8 +101025,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -83891,7 +101035,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -83899,13 +101043,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 55, + "id": 58, "name": "error", "kind": 1024, "kindString": "Property", @@ -83913,8 +101057,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -83926,8 +101071,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54, 55] + "children": [57, 58] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -83935,14 +101087,14 @@ { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 57, + "id": 60, "name": "data", "kind": 1024, "kindString": "Property", @@ -83950,8 +101102,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -83960,7 +101113,7 @@ } }, { - "id": 58, + "id": 61, "name": "error", "kind": 1024, "kindString": "Property", @@ -83968,13 +101121,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -83982,8 +101136,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [57, 58] + "children": [60, 61] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -83991,15 +101152,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 86, + "id": 89, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -84007,29 +101168,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 87, + "id": 90, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 88, + "id": 91, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -84046,14 +101226,14 @@ { "type": "reflection", "declaration": { - "id": 89, + "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 90, + "id": 93, "name": "data", "kind": 1024, "kindString": "Property", @@ -84061,21 +101241,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 94, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 95, "name": "message", "kind": 1024, "kindString": "Property", @@ -84083,8 +101264,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -84096,15 +101278,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [92] + "children": [95] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 93, + "id": 96, "name": "error", "kind": 1024, "kindString": "Property", @@ -84112,8 +101301,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -84125,8 +101315,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [90, 93] + "children": [93, 96] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -84134,14 +101331,14 @@ { "type": "reflection", "declaration": { - "id": 94, + "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 95, + "id": 98, "name": "data", "kind": 1024, "kindString": "Property", @@ -84149,8 +101346,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -84159,7 +101357,7 @@ } }, { - "id": 96, + "id": 99, "name": "error", "kind": 1024, "kindString": "Property", @@ -84167,13 +101365,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -84181,8 +101380,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [95, 96] + "children": [98, 99] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -84190,15 +101396,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 75, + "id": 78, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -84206,29 +101412,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 76, + "id": 79, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 77, + "id": 80, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -84245,14 +101462,14 @@ { "type": "reflection", "declaration": { - "id": 78, + "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, + "id": 82, "name": "data", "kind": 1024, "kindString": "Property", @@ -84260,21 +101477,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 83, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 81, + "id": 84, "name": "message", "kind": 1024, "kindString": "Property", @@ -84282,8 +101500,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -84295,15 +101514,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [81] + "children": [84] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 82, + "id": 85, "name": "error", "kind": 1024, "kindString": "Property", @@ -84311,8 +101537,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -84324,8 +101551,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [79, 82] + "children": [82, 85] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -84333,14 +101567,14 @@ { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "data", "kind": 1024, "kindString": "Property", @@ -84348,8 +101582,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -84358,7 +101593,7 @@ } }, { - "id": 85, + "id": 88, "name": "error", "kind": 1024, "kindString": "Property", @@ -84366,13 +101601,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -84380,8 +101616,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [84, 85] + "children": [87, 88] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -84389,15 +101632,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 35, + "id": 38, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -84405,29 +101648,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 36, + "id": 39, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 37, + "id": 40, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -84444,14 +101698,14 @@ { "type": "reflection", "declaration": { - "id": 38, + "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 39, + "id": 42, "name": "data", "kind": 1024, "kindString": "Property", @@ -84459,18 +101713,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 40, + "id": 43, "name": "error", "kind": 1024, "kindString": "Property", @@ -84478,8 +101733,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -84491,8 +101747,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [39, 40] + "children": [42, 43] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -84500,14 +101763,14 @@ { "type": "reflection", "declaration": { - "id": 41, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 42, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -84515,8 +101778,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -84525,7 +101789,7 @@ } }, { - "id": 43, + "id": 46, "name": "error", "kind": 1024, "kindString": "Property", @@ -84533,13 +101797,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -84547,8 +101812,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [42, 43] + "children": [45, 46] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -84556,15 +101828,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 27, + "id": 30, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -84572,19 +101844,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 28, + "id": 31, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -84595,14 +101873,14 @@ { "type": "reflection", "declaration": { - "id": 29, + "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 30, + "id": 33, "name": "data", "kind": 1024, "kindString": "Property", @@ -84610,21 +101888,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 31, + "id": 34, "name": "error", "kind": 1024, "kindString": "Property", @@ -84632,8 +101911,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -84645,8 +101925,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [30, 31] + "children": [33, 34] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -84654,14 +101941,14 @@ { "type": "reflection", "declaration": { - "id": 32, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 33, + "id": 36, "name": "data", "kind": 1024, "kindString": "Property", @@ -84669,8 +101956,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -84679,7 +101967,7 @@ } }, { - "id": 34, + "id": 37, "name": "error", "kind": 1024, "kindString": "Property", @@ -84687,13 +101975,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -84701,8 +101990,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [33, 34] + "children": [36, 37] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -84710,15 +102006,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 59, + "id": 28, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 29, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 3, + "name": "default" + } + } + ] + }, + { + "id": 62, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -84726,29 +102061,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 60, + "id": 63, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 61, + "id": 64, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -84756,7 +102102,7 @@ } }, { - "id": 62, + "id": 65, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -84764,14 +102110,14 @@ "type": { "type": "reflection", "declaration": { - "id": 63, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 66, + "id": 69, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -84779,13 +102125,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -84806,7 +102158,7 @@ } }, { - "id": 65, + "id": 68, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -84814,13 +102166,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -84842,19 +102200,25 @@ } }, { - "id": 64, + "id": 67, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -84866,8 +102230,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [66, 65, 64] + "children": [69, 68, 67] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -84883,14 +102254,14 @@ { "type": "reflection", "declaration": { - "id": 67, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 68, + "id": 71, "name": "data", "kind": 1024, "kindString": "Property", @@ -84898,21 +102269,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 69, + "id": 72, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 73, "name": "message", "kind": 1024, "kindString": "Property", @@ -84920,8 +102292,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -84933,15 +102306,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [70] + "children": [73] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 71, + "id": 74, "name": "error", "kind": 1024, "kindString": "Property", @@ -84949,8 +102329,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -84962,8 +102343,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [68, 71] + "children": [71, 74] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -84971,14 +102359,14 @@ { "type": "reflection", "declaration": { - "id": 72, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 73, + "id": 76, "name": "data", "kind": 1024, "kindString": "Property", @@ -84986,8 +102374,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -84996,7 +102385,7 @@ } }, { - "id": 74, + "id": 77, "name": "error", "kind": 1024, "kindString": "Property", @@ -85004,13 +102393,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -85018,8 +102408,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [73, 74] + "children": [76, 77] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -85027,9 +102424,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -85038,26 +102435,25 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [4] }, { "title": "Methods", - "kind": 2048, - "children": [44, 86, 75, 35, 27, 59] + "children": [47, 89, 78, 38, 30, 28, 62] } ], "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 8, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L8" } ], "extendedBy": [ { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" } ] @@ -85066,7 +102462,6 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [3] } ], @@ -85074,26 +102469,27 @@ { "fileName": "src/packages/StorageBucketApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L1" } ] }, { - "id": 97, + "id": 100, "name": "packages/StorageFileApi", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 98, + "id": 101, "name": "default", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 99, + "id": 102, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -85101,20 +102497,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 48, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L51" } ], "signatures": [ { - "id": 100, + "id": 103, "name": "new default", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 101, + "id": 104, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -85125,7 +102522,7 @@ } }, { - "id": 102, + "id": 105, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -85133,20 +102530,28 @@ "type": { "type": "reflection", "declaration": { - "id": 103, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 53, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L53" + } + ], "indexSignature": { - "id": 104, + "id": 107, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 105, + "id": 108, "name": "key", "kind": 32768, "flags": {}, @@ -85166,7 +102571,7 @@ "defaultValue": "{}" }, { - "id": 106, + "id": 109, "name": "bucketId", "kind": 32768, "kindString": "Parameter", @@ -85179,7 +102584,7 @@ } }, { - "id": 107, + "id": 110, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -85189,34 +102594,41 @@ "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 109, + "id": 112, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 110, + "id": 113, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 111, + "id": 114, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -85225,9 +102637,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -85236,14 +102648,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -85253,14 +102665,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 213, + "id": 219, "name": "copy", "kind": 2048, "kindString": "Method", @@ -85268,29 +102680,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 355, - "character": 8 + "line": 378, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L378" } ], "signatures": [ { - "id": 214, + "id": 220, "name": "copy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Copies an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 215, + "id": 221, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -85298,13 +102729,26 @@ } }, { - "id": 216, + "id": 222, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-copy.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -85312,7 +102756,7 @@ } }, { - "id": 217, + "id": 223, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -85320,21 +102764,26 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions", "dereferenced": { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -85345,7 +102794,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -85357,15 +102807,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] } @@ -85381,14 +102831,14 @@ { "type": "reflection", "declaration": { - "id": 218, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 225, "name": "data", "kind": 1024, "kindString": "Property", @@ -85396,21 +102846,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 8 + "line": 384, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 221, + "id": 227, "name": "path", "kind": 1024, "kindString": "Property", @@ -85418,8 +102869,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 16 + "line": 384, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { @@ -85431,15 +102883,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [221] + "children": [227] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 384, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ] } } }, { - "id": 222, + "id": 228, "name": "error", "kind": 1024, "kindString": "Property", @@ -85447,8 +102906,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 362, - "character": 8 + "line": 385, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L385" } ], "type": { @@ -85460,8 +102920,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [219, 222] + "children": [225, 228] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L383" } ] } @@ -85469,14 +102936,14 @@ { "type": "reflection", "declaration": { - "id": 223, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 224, + "id": 230, "name": "data", "kind": 1024, "kindString": "Property", @@ -85484,8 +102951,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 365, - "character": 8 + "line": 388, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L388" } ], "type": { @@ -85494,7 +102962,7 @@ } }, { - "id": 225, + "id": 231, "name": "error", "kind": 1024, "kindString": "Property", @@ -85502,13 +102970,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 366, - "character": 8 + "line": 389, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L389" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -85516,8 +102985,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [224, 225] + "children": [230, 231] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 387, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L387" } ] } @@ -85525,15 +103001,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 169, + "id": 175, "name": "createSignedUploadUrl", "kind": 2048, "kindString": "Method", @@ -85541,29 +103017,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 225, - "character": 8 + "line": 242, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L242" } ], "signatures": [ { - "id": 170, + "id": 176, "name": "createSignedUploadUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + "summary": [ + { + "kind": "text", + "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + } + ] }, "parameters": [ { - "id": 171, + "id": 177, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -85571,7 +103066,7 @@ } }, { - "id": 172, + "id": 178, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -85581,26 +103076,32 @@ "type": { "type": "reflection", "declaration": { - "id": 173, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 180, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + "summary": [ + { + "kind": "text", + "text": "If set to true, allows the file to be overwritten if it already exists." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, - "character": 16 + "line": 244, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ], "type": { @@ -85612,8 +103113,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [174] + "children": [180] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 244, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ] } @@ -85629,14 +103137,14 @@ { "type": "reflection", "declaration": { - "id": 175, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 176, + "id": 182, "name": "data", "kind": 1024, "kindString": "Property", @@ -85644,21 +103152,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 8 + "line": 247, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { "type": "reflection", "declaration": { - "id": 177, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 180, + "id": 186, "name": "path", "kind": 1024, "kindString": "Property", @@ -85666,8 +103175,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 50 + "line": 247, + "character": 50, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -85676,7 +103186,7 @@ } }, { - "id": 178, + "id": 184, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -85684,8 +103194,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 16 + "line": 247, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -85694,7 +103205,7 @@ } }, { - "id": 179, + "id": 185, "name": "token", "kind": 1024, "kindString": "Property", @@ -85702,8 +103213,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 35 + "line": 247, + "character": 35, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -85715,15 +103227,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [180, 178, 179] + "children": [186, 184, 185] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 247, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ] } } }, { - "id": 181, + "id": 187, "name": "error", "kind": 1024, "kindString": "Property", @@ -85731,8 +103250,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 + "line": 248, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L248" } ], "type": { @@ -85744,8 +103264,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [176, 181] + "children": [182, 187] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 246, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L246" } ] } @@ -85753,14 +103280,14 @@ { "type": "reflection", "declaration": { - "id": 182, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 183, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -85768,8 +103295,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 234, - "character": 8 + "line": 251, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L251" } ], "type": { @@ -85778,7 +103306,7 @@ } }, { - "id": 184, + "id": 190, "name": "error", "kind": 1024, "kindString": "Property", @@ -85786,13 +103314,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 235, - "character": 8 + "line": 252, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L252" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -85800,8 +103329,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [183, 184] + "children": [189, 190] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 250, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L250" } ] } @@ -85809,15 +103345,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 226, + "id": 232, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -85825,29 +103361,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 399, - "character": 8 + "line": 425, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L425" } ], "signatures": [ { - "id": 227, + "id": 233, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 228, + "id": 234, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -85855,13 +103410,26 @@ } }, { - "id": 229, + "id": 235, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URL expires. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for a URL which is valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -85869,7 +103437,7 @@ } }, { - "id": 230, + "id": 236, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -85879,14 +103447,14 @@ "type": { "type": "reflection", "declaration": { - "id": 231, + "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 232, + "id": 238, "name": "download", "kind": 1024, "kindString": "Property", @@ -85894,13 +103462,19 @@ "isOptional": true }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 16 + "line": 428, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { @@ -85918,7 +103492,7 @@ } }, { - "id": 233, + "id": 239, "name": "transform", "kind": 1024, "kindString": "Property", @@ -85926,28 +103500,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 45 + "line": 428, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -85955,14 +103535,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -85971,7 +103556,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -85979,13 +103564,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -85994,7 +103585,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -86002,13 +103593,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -86017,7 +103614,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -86025,13 +103622,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -86053,7 +103656,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -86061,13 +103664,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -86079,15 +103688,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -86097,8 +103706,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [232, 233] + "children": [238, 239] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 428, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ] } @@ -86114,14 +103730,14 @@ { "type": "reflection", "declaration": { - "id": 234, + "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 235, + "id": 241, "name": "data", "kind": 1024, "kindString": "Property", @@ -86129,21 +103745,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 8 + "line": 431, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 243, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -86151,8 +103768,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 16 + "line": 431, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { @@ -86164,15 +103782,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [243] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 431, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ] } } }, { - "id": 238, + "id": 244, "name": "error", "kind": 1024, "kindString": "Property", @@ -86180,8 +103805,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 406, - "character": 8 + "line": 432, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L432" } ], "type": { @@ -86193,8 +103819,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [235, 238] + "children": [241, 244] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 430, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L430" } ] } @@ -86202,14 +103835,14 @@ { "type": "reflection", "declaration": { - "id": 239, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 240, + "id": 246, "name": "data", "kind": 1024, "kindString": "Property", @@ -86217,8 +103850,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 409, - "character": 8 + "line": 435, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L435" } ], "type": { @@ -86227,7 +103861,7 @@ } }, { - "id": 241, + "id": 247, "name": "error", "kind": 1024, "kindString": "Property", @@ -86235,13 +103869,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 410, - "character": 8 + "line": 436, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L436" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -86249,8 +103884,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [240, 241] + "children": [246, 247] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 434, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L434" } ] } @@ -86258,15 +103900,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 242, + "id": 248, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -86274,29 +103916,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 444, - "character": 8 + "line": 473, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L473" } ], "signatures": [ { - "id": 243, + "id": 249, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 244, + "id": 250, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." + "summary": [ + { + "kind": "text", + "text": "The file paths to be downloaded, including the current file names. For example " + }, + { + "kind": "code", + "text": "`['folder/image.png', 'folder2/image2.png']`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "array", @@ -86307,13 +103968,26 @@ } }, { - "id": 245, + "id": 251, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URLs expire. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for URLs which are valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -86321,7 +103995,7 @@ } }, { - "id": 246, + "id": 252, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -86331,26 +104005,32 @@ "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 253, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 248, + "id": 254, "name": "download", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 447, - "character": 16 + "line": 476, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ], "type": { @@ -86371,8 +104051,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [248] + "children": [254] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 476, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ] } @@ -86388,14 +104075,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 256, "name": "data", "kind": 1024, "kindString": "Property", @@ -86403,8 +104090,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 8 + "line": 479, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -86412,14 +104100,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 251, + "id": 257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 252, + "id": 258, "name": "error", "kind": 1024, "kindString": "Property", @@ -86427,8 +104115,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 16 + "line": 479, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -86446,7 +104135,7 @@ } }, { - "id": 253, + "id": 259, "name": "path", "kind": 1024, "kindString": "Property", @@ -86454,8 +104143,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 38 + "line": 479, + "character": 38, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -86473,7 +104163,7 @@ } }, { - "id": 254, + "id": 260, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -86481,8 +104171,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 59 + "line": 479, + "character": 59, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -86494,8 +104185,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [252, 253, 254] + "children": [258, 259, 260] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ] } @@ -86503,7 +104201,7 @@ } }, { - "id": 255, + "id": 261, "name": "error", "kind": 1024, "kindString": "Property", @@ -86511,8 +104209,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 451, - "character": 8 + "line": 480, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L480" } ], "type": { @@ -86524,8 +104223,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [250, 255] + "children": [256, 261] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 478, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L478" } ] } @@ -86533,14 +104239,14 @@ { "type": "reflection", "declaration": { - "id": 256, + "id": 262, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 263, "name": "data", "kind": 1024, "kindString": "Property", @@ -86548,8 +104254,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 454, - "character": 8 + "line": 483, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L483" } ], "type": { @@ -86558,7 +104265,7 @@ } }, { - "id": 258, + "id": 264, "name": "error", "kind": 1024, "kindString": "Property", @@ -86566,13 +104273,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 455, - "character": 8 + "line": 484, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L484" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -86580,8 +104288,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [257, 258] + "children": [263, 264] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 482, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L482" } ] } @@ -86589,15 +104304,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 259, + "id": 265, "name": "download", "kind": 2048, "kindString": "Method", @@ -86605,29 +104320,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 493, - "character": 8 + "line": 525, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L525" } ], "signatures": [ { - "id": 260, + "id": 266, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." + "summary": [ + { + "kind": "text", + "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " + }, + { + "kind": "code", + "text": "`getPublicUrl`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "parameters": [ { - "id": 261, + "id": 267, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The full path and file name of the file to be downloaded. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -86635,7 +104377,7 @@ } }, { - "id": 262, + "id": 268, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -86645,14 +104387,14 @@ "type": { "type": "reflection", "declaration": { - "id": 263, + "id": 269, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 264, + "id": 270, "name": "transform", "kind": 1024, "kindString": "Property", @@ -86660,28 +104402,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 495, - "character": 16 + "line": 527, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -86689,14 +104437,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -86705,7 +104458,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -86713,13 +104466,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -86728,7 +104487,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -86736,13 +104495,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -86751,7 +104516,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -86759,13 +104524,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -86787,7 +104558,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -86795,13 +104566,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -86813,15 +104590,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -86831,8 +104608,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [264] + "children": [270] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 527, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ] } @@ -86848,14 +104632,14 @@ { "type": "reflection", "declaration": { - "id": 265, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 266, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -86863,19 +104647,20 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 498, - "character": 8 + "line": 530, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L530" } ], "type": { "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "name": "Blob", + "qualifiedName": "Blob", + "package": "typescript" } }, { - "id": 267, + "id": 273, "name": "error", "kind": 1024, "kindString": "Property", @@ -86883,8 +104668,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 499, - "character": 8 + "line": 531, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L531" } ], "type": { @@ -86896,8 +104682,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [266, 267] + "children": [272, 273] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 529, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L529" } ] } @@ -86905,14 +104698,14 @@ { "type": "reflection", "declaration": { - "id": 268, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 275, "name": "data", "kind": 1024, "kindString": "Property", @@ -86920,8 +104713,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 502, - "character": 8 + "line": 534, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L534" } ], "type": { @@ -86930,7 +104724,7 @@ } }, { - "id": 270, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -86938,13 +104732,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 503, - "character": 8 + "line": 535, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L535" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -86952,8 +104747,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [269, 270] + "children": [275, 276] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 533, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L533" } ] } @@ -86961,15 +104763,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 280, + "id": 286, "name": "exists", "kind": 2048, "kindString": "Method", @@ -86977,30 +104779,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 565, - "character": 8 + "line": 603, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L603" } ], "signatures": [ { - "id": 281, + "id": 287, "name": "exists", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Checks the existence of a file." + "summary": [ + { + "kind": "text", + "text": "Checks the existence of a file." + } + ] }, "parameters": [ { - "id": 282, + "id": 288, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -87016,14 +104821,14 @@ { "type": "reflection", "declaration": { - "id": 283, + "id": 289, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 290, "name": "data", "kind": 1024, "kindString": "Property", @@ -87031,8 +104836,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 569, - "character": 8 + "line": 607, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L607" } ], "type": { @@ -87041,7 +104847,7 @@ } }, { - "id": 285, + "id": 291, "name": "error", "kind": 1024, "kindString": "Property", @@ -87049,8 +104855,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 570, - "character": 8 + "line": 608, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L608" } ], "type": { @@ -87062,8 +104869,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [284, 285] + "children": [290, 291] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 606, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L606" } ] } @@ -87071,14 +104885,14 @@ { "type": "reflection", "declaration": { - "id": 286, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 293, "name": "data", "kind": 1024, "kindString": "Property", @@ -87086,8 +104900,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 573, - "character": 8 + "line": 611, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L611" } ], "type": { @@ -87096,7 +104911,7 @@ } }, { - "id": 288, + "id": 294, "name": "error", "kind": 1024, "kindString": "Property", @@ -87104,13 +104919,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 574, - "character": 8 + "line": 612, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L612" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -87118,8 +104934,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [287, 288] + "children": [293, 294] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 610, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L610" } ] } @@ -87127,15 +104950,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 289, + "id": 295, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -87143,29 +104966,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 606, - "character": 2 + "line": 647, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L647" } ], "signatures": [ { - "id": 290, + "id": 296, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + "summary": [ + { + "kind": "text", + "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + } + ] }, "parameters": [ { - "id": 291, + "id": 297, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The path and name of the file to generate the public URL for. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -87173,7 +105015,7 @@ } }, { - "id": 292, + "id": 298, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -87183,14 +105025,14 @@ "type": { "type": "reflection", "declaration": { - "id": 293, + "id": 299, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 294, + "id": 300, "name": "download", "kind": 1024, "kindString": "Property", @@ -87198,13 +105040,19 @@ "isOptional": true }, "comment": { - "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 16 + "line": 649, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { @@ -87222,7 +105070,7 @@ } }, { - "id": 295, + "id": 301, "name": "transform", "kind": 1024, "kindString": "Property", @@ -87230,28 +105078,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 45 + "line": 649, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -87259,14 +105113,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -87275,7 +105134,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -87283,13 +105142,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -87298,7 +105163,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -87306,13 +105171,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -87321,7 +105192,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -87329,13 +105200,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -87357,7 +105234,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -87365,13 +105242,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -87383,15 +105266,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -87401,8 +105284,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [294, 295] + "children": [300, 301] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 649, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ] } @@ -87412,14 +105302,14 @@ "type": { "type": "reflection", "declaration": { - "id": 296, + "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 297, + "id": 303, "name": "data", "kind": 1024, "kindString": "Property", @@ -87427,21 +105317,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 7 + "line": 650, + "character": 7, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { "type": "reflection", "declaration": { - "id": 298, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 299, + "id": 305, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -87449,8 +105340,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 15 + "line": 650, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { @@ -87462,8 +105354,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [299] + "children": [305] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ] } @@ -87473,8 +105372,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [297] + "children": [303] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 5, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ] } @@ -87483,7 +105389,7 @@ ] }, { - "id": 271, + "id": 277, "name": "info", "kind": 2048, "kindString": "Method", @@ -87491,30 +105397,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 532, - "character": 8 + "line": 567, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L567" } ], "signatures": [ { - "id": 272, + "id": 278, "name": "info", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing file." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing file." + } + ] }, "parameters": [ { - "id": 273, + "id": 279, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -87530,14 +105439,14 @@ { "type": "reflection", "declaration": { - "id": 274, + "id": 280, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 281, "name": "data", "kind": 1024, "kindString": "Property", @@ -87545,17 +105454,18 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 536, - "character": 8 + "line": 571, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L571" } ], "type": { "type": "reference", - "id": 494, + "id": 524, "typeArguments": [ { "type": "reference", - "id": 453, + "id": 472, "name": "FileObjectV2" } ], @@ -87563,7 +105473,7 @@ } }, { - "id": 276, + "id": 282, "name": "error", "kind": 1024, "kindString": "Property", @@ -87571,8 +105481,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 537, - "character": 8 + "line": 572, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L572" } ], "type": { @@ -87584,8 +105495,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [275, 276] + "children": [281, 282] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 570, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L570" } ] } @@ -87593,14 +105511,14 @@ { "type": "reflection", "declaration": { - "id": 277, + "id": 283, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 278, + "id": 284, "name": "data", "kind": 1024, "kindString": "Property", @@ -87608,8 +105526,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 540, - "character": 8 + "line": 575, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L575" } ], "type": { @@ -87618,7 +105537,7 @@ } }, { - "id": 279, + "id": 285, "name": "error", "kind": 1024, "kindString": "Property", @@ -87626,13 +105545,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 541, - "character": 8 + "line": 576, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L576" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -87640,8 +105560,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [278, 279] + "children": [284, 285] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 574, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L574" } ] } @@ -87649,15 +105576,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 309, + "id": 315, "name": "list", "kind": 2048, "kindString": "Method", @@ -87665,23 +105592,29 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 741, - "character": 8 + "line": 785, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L785" } ], "signatures": [ { - "id": 310, + "id": 316, "name": "list", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all the files within a bucket." + "summary": [ + { + "kind": "text", + "text": "Lists all the files and folders within a path of the bucket." + } + ] }, "parameters": [ { - "id": 311, + "id": 317, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -87689,7 +105622,12 @@ "isOptional": true }, "comment": { - "shortText": "The folder path." + "summary": [ + { + "kind": "text", + "text": "The folder path." + } + ] }, "type": { "type": "intrinsic", @@ -87697,7 +105635,7 @@ } }, { - "id": 312, + "id": 318, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -87705,21 +105643,26 @@ "isOptional": true }, "comment": { - "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search\n" + "summary": [ + { + "kind": "text", + "text": "Search options including limit (defaults to 100), offset, sortBy, and search" + } + ] }, "type": { "type": "reference", - "id": 479, + "id": 498, "name": "SearchOptions", "dereferenced": { - "id": 479, + "id": 498, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 480, + "id": 499, "name": "limit", "kind": 1024, "kindString": "Property", @@ -87727,11 +105670,21 @@ "isOptional": true }, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "The number of files you want to be returned." + } + ], + "blockTags": [ { - "tag": "default", - "text": "100\n" + "tag": "@default", + "content": [ + { + "kind": "text", + "text": "100" + } + ] } ] }, @@ -87739,7 +105692,8 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L86" } ], "type": { @@ -87748,7 +105702,7 @@ } }, { - "id": 481, + "id": 500, "name": "offset", "kind": 1024, "kindString": "Property", @@ -87756,13 +105710,19 @@ "isOptional": true }, "comment": { - "shortText": "The starting position." + "summary": [ + { + "kind": "text", + "text": "The starting position." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L91" } ], "type": { @@ -87771,7 +105731,7 @@ } }, { - "id": 483, + "id": 502, "name": "search", "kind": 1024, "kindString": "Property", @@ -87779,13 +105739,19 @@ "isOptional": true }, "comment": { - "shortText": "The search string to filter files by." + "summary": [ + { + "kind": "text", + "text": "The search string to filter files by." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L101" } ], "type": { @@ -87794,7 +105760,7 @@ } }, { - "id": 482, + "id": 501, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -87802,28 +105768,34 @@ "isOptional": true }, "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." + "summary": [ + { + "kind": "text", + "text": "The column to sort by. Can be any column inside a FileObject." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 96, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L96" } ], "type": { "type": "reference", - "id": 467, + "id": 486, "name": "SortBy", "dereferenced": { - "id": 467, + "id": 486, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, + "id": 487, "name": "column", "kind": 1024, "kindString": "Property", @@ -87834,7 +105806,8 @@ { "fileName": "src/lib/types.ts", "line": 44, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" } ], "type": { @@ -87843,7 +105816,7 @@ } }, { - "id": 469, + "id": 488, "name": "order", "kind": 1024, "kindString": "Property", @@ -87854,7 +105827,8 @@ { "fileName": "src/lib/types.ts", "line": 45, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" } ], "type": { @@ -87866,15 +105840,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [487, 488] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 43, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" } ] } @@ -87884,22 +105858,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [480, 481, 483, 482] + "children": [499, 500, 502, 501] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 81, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L81" } ] } } }, { - "id": 313, + "id": 319, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -87908,17 +105882,17 @@ }, "type": { "type": "reference", - "id": 484, + "id": 514, "name": "FetchParameters", "dereferenced": { - "id": 484, + "id": 514, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 485, + "id": 515, "name": "signal", "kind": 1024, "kindString": "Property", @@ -87926,35 +105900,419 @@ "isOptional": true }, "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "groups": [ { "title": "Properties", + "children": [515] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 320, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 321, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 791, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L791" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 462, + "name": "FileObject" + } + } + }, + { + "id": 322, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 792, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L792" + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [321, 322] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 790, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L790" + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 323, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 324, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 795, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L795" + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 325, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 796, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L796" + } + ], + "type": { + "type": "reference", + "id": 529, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [324, 325] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 794, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L794" + } + ] + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 326, + "name": "listV2", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 826, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L826" + } + ], + "signatures": [ + { + "id": 327, + "name": "listV2", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "this method signature might change in the future" + } + ], + "modifierTags": ["@experimental"] + }, + "parameters": [ + { + "id": 328, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "search options" + } + ] + }, + "type": { + "type": "reference", + "id": 503, + "name": "SearchV2Options", + "dereferenced": { + "id": 503, + "name": "SearchV2Options", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 506, + "name": "cursor", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L107" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 504, + "name": "limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L105" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 505, + "name": "prefix", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L106" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 507, + "name": "with_delimiter", "kind": 1024, - "children": [485] + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L108" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [506, 504, 505, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 104, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L104" + } + ] + } + } + }, + { + "id": 329, + "name": "parameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 514, + "name": "FetchParameters", + "dereferenced": { + "id": 514, + "name": "FetchParameters", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 515, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" + } + ], + "type": { + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [515] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" } ] } @@ -87970,14 +106328,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 331, "name": "data", "kind": 1024, "kindString": "Property", @@ -87985,21 +106343,19 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 747, - "character": 8 + "line": 831, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L831" } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 443, - "name": "FileObject" - } + "type": "reference", + "id": 508, + "name": "SearchV2Result" } }, { - "id": 316, + "id": 332, "name": "error", "kind": 1024, "kindString": "Property", @@ -88007,8 +106363,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 748, - "character": 8 + "line": 832, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L832" } ], "type": { @@ -88020,8 +106377,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [315, 316] + "children": [331, 332] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 830, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L830" } ] } @@ -88029,14 +106393,14 @@ { "type": "reflection", "declaration": { - "id": 317, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 318, + "id": 334, "name": "data", "kind": 1024, "kindString": "Property", @@ -88044,8 +106408,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 751, - "character": 8 + "line": 835, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L835" } ], "type": { @@ -88054,7 +106419,7 @@ } }, { - "id": 319, + "id": 335, "name": "error", "kind": 1024, "kindString": "Property", @@ -88062,13 +106427,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 752, - "character": 8 + "line": 836, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L836" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -88076,8 +106442,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [318, 319] + "children": [334, 335] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 834, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L834" } ] } @@ -88085,15 +106458,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 200, + "id": 206, "name": "move", "kind": 2048, "kindString": "Method", @@ -88101,29 +106474,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, - "character": 8 + "line": 332, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L332" } ], "signatures": [ { - "id": 201, + "id": 207, "name": "move", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Moves an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 202, + "id": 208, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -88131,13 +106523,26 @@ } }, { - "id": 203, + "id": 209, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-new.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -88145,7 +106550,7 @@ } }, { - "id": 204, + "id": 210, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -88153,21 +106558,26 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions", "dereferenced": { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -88178,7 +106588,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -88190,15 +106601,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] } @@ -88214,14 +106625,14 @@ { "type": "reflection", "declaration": { - "id": 205, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 206, + "id": 212, "name": "data", "kind": 1024, "kindString": "Property", @@ -88229,21 +106640,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 8 + "line": 338, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 208, + "id": 214, "name": "message", "kind": 1024, "kindString": "Property", @@ -88251,8 +106663,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 16 + "line": 338, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { @@ -88264,15 +106677,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [208] + "children": [214] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 338, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ] } } }, { - "id": 209, + "id": 215, "name": "error", "kind": 1024, "kindString": "Property", @@ -88280,8 +106700,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 319, - "character": 8 + "line": 339, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L339" } ], "type": { @@ -88293,8 +106714,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [206, 209] + "children": [212, 215] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 337, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L337" } ] } @@ -88302,14 +106730,14 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 217, "name": "data", "kind": 1024, "kindString": "Property", @@ -88317,8 +106745,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 322, - "character": 8 + "line": 342, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L342" } ], "type": { @@ -88327,7 +106756,7 @@ } }, { - "id": 212, + "id": 218, "name": "error", "kind": 1024, "kindString": "Property", @@ -88335,13 +106764,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 323, - "character": 8 + "line": 343, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L343" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -88349,8 +106779,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [211, 212] + "children": [217, 218] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 341, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L341" } ] } @@ -88358,15 +106795,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 300, + "id": 306, "name": "remove", "kind": 2048, "kindString": "Method", @@ -88374,29 +106811,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 644, - "character": 8 + "line": 685, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L685" } ], "signatures": [ { - "id": 301, + "id": 307, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes files within the same bucket" + "summary": [ + { + "kind": "text", + "text": "Deletes files within the same bucket" + } + ] }, "parameters": [ { - "id": 302, + "id": 308, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" + "summary": [ + { + "kind": "text", + "text": "An array of files to delete, including the path and file name. For example [" + }, + { + "kind": "code", + "text": "`'folder/image.png'`" + }, + { + "kind": "text", + "text": "]." + } + ] }, "type": { "type": "array", @@ -88416,14 +106872,14 @@ { "type": "reflection", "declaration": { - "id": 303, + "id": 309, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 304, + "id": 310, "name": "data", "kind": 1024, "kindString": "Property", @@ -88431,21 +106887,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 648, - "character": 8 + "line": 689, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L689" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 443, + "id": 462, "name": "FileObject" } } }, { - "id": 305, + "id": 311, "name": "error", "kind": 1024, "kindString": "Property", @@ -88453,8 +106910,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 649, - "character": 8 + "line": 690, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L690" } ], "type": { @@ -88466,8 +106924,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [304, 305] + "children": [310, 311] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 688, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L688" } ] } @@ -88475,14 +106940,14 @@ { "type": "reflection", "declaration": { - "id": 306, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 307, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -88490,8 +106955,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 652, - "character": 8 + "line": 693, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L693" } ], "type": { @@ -88500,7 +106966,7 @@ } }, { - "id": 308, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -88508,13 +106974,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, - "character": 8 + "line": 694, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L694" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -88522,8 +106989,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [307, 308] + "children": [313, 314] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 692, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L692" } ] } @@ -88531,15 +107005,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 323, + "id": 127, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 66, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L66" + } + ], + "signatures": [ + { + "id": 128, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 101, + "name": "default" + } + } + ] + }, + { + "id": 339, "name": "toBase64", "kind": 2048, "kindString": "Method", @@ -88547,20 +107060,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 778, - "character": 2 + "line": 865, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L865" } ], "signatures": [ { - "id": 324, + "id": 340, "name": "toBase64", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 325, + "id": 341, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -88579,7 +107093,7 @@ ] }, { - "id": 185, + "id": 191, "name": "update", "kind": 2048, "kindString": "Method", @@ -88587,29 +107101,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 278, - "character": 8 + "line": 298, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L298" } ], "signatures": [ { - "id": 186, + "id": 192, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." + "summary": [ + { + "kind": "text", + "text": "Replaces an existing file at the specified path with a new one." + } + ] }, "parameters": [ { - "id": 187, + "id": 193, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." + "summary": [ + { + "kind": "text", + "text": "The relative file path. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to update." + } + ] }, "type": { "type": "intrinsic", @@ -88617,13 +107150,18 @@ } }, { - "id": 188, + "id": 194, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "union", @@ -88634,71 +107172,71 @@ }, { "type": "reference", + "name": "ArrayBuffer", "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" + "package": "typescript" }, { "type": "reference", + "name": "ArrayBufferView", "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" + "package": "typescript" }, { "type": "reference", + "name": "Blob", "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "package": "typescript" }, { "type": "reference", + "name": "Buffer", "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" + "package": "@types/node" }, { "type": "reference", + "name": "File", "qualifiedName": "File", - "package": "typescript", - "name": "File" + "package": "typescript" }, { "type": "reference", + "name": "FormData", "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" + "package": "typescript" }, { "type": "reference", + "name": "ReadableStream", "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" + "package": "@types/node" }, { "type": "reference", "typeArguments": [ { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } ], + "name": "ReadableStream", "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" + "package": "typescript" }, { "type": "reference", + "name": "URLSearchParams", "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" + "package": "typescript" } ] } }, { - "id": 189, + "id": 195, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -88707,17 +107245,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -88725,13 +107263,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -88740,7 +107292,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -88748,13 +107300,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -88763,7 +107369,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -88771,13 +107377,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -88786,7 +107398,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -88794,13 +107406,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -88815,13 +107433,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -88829,13 +107447,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -88850,13 +107474,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -88864,13 +107488,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -88882,15 +107512,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -88906,14 +107536,14 @@ { "type": "reflection", "declaration": { - "id": 190, + "id": 196, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 191, + "id": 197, "name": "data", "kind": 1024, "kindString": "Property", @@ -88921,21 +107551,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 8 + "line": 314, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { "type": "reflection", "declaration": { - "id": 192, + "id": 198, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 201, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -88943,8 +107574,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 42 + "line": 314, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -88953,7 +107585,7 @@ } }, { - "id": 193, + "id": 199, "name": "id", "kind": 1024, "kindString": "Property", @@ -88961,8 +107593,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 16 + "line": 314, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -88971,7 +107604,7 @@ } }, { - "id": 194, + "id": 200, "name": "path", "kind": 1024, "kindString": "Property", @@ -88979,8 +107612,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 28 + "line": 314, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -88992,15 +107626,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [195, 193, 194] + "children": [201, 199, 200] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 314, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ] } } }, { - "id": 196, + "id": 202, "name": "error", "kind": 1024, "kindString": "Property", @@ -89008,8 +107649,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 295, - "character": 8 + "line": 315, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L315" } ], "type": { @@ -89021,8 +107663,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [191, 196] + "children": [197, 202] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 313, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L313" } ] } @@ -89030,14 +107679,14 @@ { "type": "reflection", "declaration": { - "id": 197, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -89045,8 +107694,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 298, - "character": 8 + "line": 318, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L318" } ], "type": { @@ -89055,7 +107705,7 @@ } }, { - "id": 199, + "id": 205, "name": "error", "kind": 1024, "kindString": "Property", @@ -89063,13 +107713,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 299, - "character": 8 + "line": 319, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L319" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -89077,8 +107728,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [198, 199] + "children": [204, 205] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L317" } ] } @@ -89086,15 +107744,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 139, + "id": 145, "name": "upload", "kind": 2048, "kindString": "Method", @@ -89102,29 +107760,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 147, - "character": 8 + "line": 161, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L161" } ], "signatures": [ { - "id": 140, + "id": 146, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Uploads a file to an existing bucket." + "summary": [ + { + "kind": "text", + "text": "Uploads a file to an existing bucket." + } + ] }, "parameters": [ { - "id": 141, + "id": 147, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -89132,13 +107809,18 @@ } }, { - "id": 142, + "id": 148, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -89146,7 +107828,7 @@ } }, { - "id": 143, + "id": 149, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -89155,17 +107837,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -89173,13 +107855,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -89188,7 +107884,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -89196,13 +107892,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -89211,7 +107961,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -89219,13 +107969,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -89234,7 +107990,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -89242,13 +107998,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -89263,13 +108025,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -89277,13 +108039,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -89298,13 +108066,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -89312,13 +108080,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -89330,15 +108104,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -89354,14 +108128,14 @@ { "type": "reflection", "declaration": { - "id": 144, + "id": 150, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 145, + "id": 151, "name": "data", "kind": 1024, "kindString": "Property", @@ -89369,21 +108143,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 8 + "line": 167, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { "type": "reflection", "declaration": { - "id": 146, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 149, + "id": 155, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -89391,8 +108166,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 42 + "line": 167, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -89401,7 +108177,7 @@ } }, { - "id": 147, + "id": 153, "name": "id", "kind": 1024, "kindString": "Property", @@ -89409,8 +108185,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 16 + "line": 167, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -89419,7 +108196,7 @@ } }, { - "id": 148, + "id": 154, "name": "path", "kind": 1024, "kindString": "Property", @@ -89427,8 +108204,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 28 + "line": 167, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -89440,15 +108218,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [149, 147, 148] + "children": [155, 153, 154] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 167, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ] } } }, { - "id": 150, + "id": 156, "name": "error", "kind": 1024, "kindString": "Property", @@ -89456,8 +108241,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 154, - "character": 8 + "line": 168, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L168" } ], "type": { @@ -89469,8 +108255,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [145, 150] + "children": [151, 156] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 166, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L166" } ] } @@ -89478,14 +108271,14 @@ { "type": "reflection", "declaration": { - "id": 151, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 158, "name": "data", "kind": 1024, "kindString": "Property", @@ -89493,8 +108286,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 157, - "character": 8 + "line": 171, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L171" } ], "type": { @@ -89503,7 +108297,7 @@ } }, { - "id": 153, + "id": 159, "name": "error", "kind": 1024, "kindString": "Property", @@ -89511,13 +108305,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, - "character": 8 + "line": 172, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L172" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -89525,8 +108320,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152, 153] + "children": [158, 159] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 170, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L170" } ] } @@ -89534,15 +108336,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 154, + "id": 160, "name": "uploadToSignedUrl", "kind": 2048, "kindString": "Method", @@ -89550,29 +108352,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 170, - "character": 8 + "line": 184, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L184" } ], "signatures": [ { - "id": 155, + "id": 161, "name": "uploadToSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." + "summary": [ + { + "kind": "text", + "text": "Upload a file with a token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 156, + "id": 162, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -89580,13 +108409,22 @@ } }, { - "id": 157, + "id": 163, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The token generated from `createSignedUploadUrl`" + "summary": [ + { + "kind": "text", + "text": "The token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + } + ] }, "type": { "type": "intrinsic", @@ -89594,13 +108432,18 @@ } }, { - "id": 158, + "id": 164, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -89608,7 +108451,7 @@ } }, { - "id": 159, + "id": 165, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -89617,17 +108460,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -89635,13 +108478,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -89650,7 +108507,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -89658,13 +108515,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -89673,7 +108584,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -89681,13 +108592,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -89696,7 +108613,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -89704,13 +108621,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -89725,13 +108648,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -89739,13 +108662,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -89760,13 +108689,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -89774,13 +108703,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -89792,15 +108727,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -89816,14 +108751,14 @@ { "type": "reflection", "declaration": { - "id": 160, + "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 161, + "id": 167, "name": "data", "kind": 1024, "kindString": "Property", @@ -89831,21 +108766,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 8 + "line": 220, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { "type": "reflection", "declaration": { - "id": 162, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 164, + "id": 170, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -89853,8 +108789,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 33 + "line": 220, + "character": 33, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -89864,7 +108801,7 @@ "defaultValue": "data.Key" }, { - "id": 163, + "id": 169, "name": "path", "kind": 1024, "kindString": "Property", @@ -89872,8 +108809,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 16 + "line": 220, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -89886,8 +108824,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [164, 163] + "children": [170, 169] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 220, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ] } @@ -89895,7 +108840,7 @@ "defaultValue": "..." }, { - "id": 165, + "id": 171, "name": "error", "kind": 1024, "kindString": "Property", @@ -89903,8 +108848,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 207, - "character": 8 + "line": 221, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L221" } ], "type": { @@ -89917,8 +108863,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [161, 165] + "children": [167, 171] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 219, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L219" } ] } @@ -89926,14 +108879,14 @@ { "type": "reflection", "declaration": { - "id": 166, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 167, + "id": 173, "name": "data", "kind": 1024, "kindString": "Property", @@ -89941,8 +108894,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 211, - "character": 17 + "line": 228, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ], "type": { @@ -89952,14 +108906,22 @@ "defaultValue": "null" }, { - "id": 168, + "id": 174, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 29, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" + } + ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -89967,8 +108929,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [167, 168] + "children": [173, 174] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ] } @@ -89976,9 +108945,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -89987,22 +108956,22 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [99] + "children": [102] }, { "title": "Methods", - "kind": 2048, "children": [ - 213, 169, 226, 242, 259, 280, 289, 271, 309, 200, 300, 323, 185, 139, 154 + 219, 175, 232, 248, 265, 286, 295, 277, 315, 326, 206, 306, 127, 339, 191, 145, + 160 ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 42, - "character": 21 + "line": 44, + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L44" } ] } @@ -90010,15 +108979,15 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [98] + "children": [101] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L1" } ] } @@ -90026,8 +108995,7 @@ "groups": [ { "title": "Modules", - "kind": 2, - "children": [1, 2, 97] + "children": [1, 2, 100] } ] }, diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json index 89fe9472f0120..1b0b90825659c 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1280, + "id": 1285, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1281, + "id": 1286, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -23,19 +23,20 @@ { "fileName": "src/lib/errors.ts", "line": 33, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L33" } ], "signatures": [ { - "id": 1282, + "id": 1287, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1283, + "id": 1288, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +47,7 @@ } }, { - "id": 1284, + "id": 1289, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -57,7 +58,7 @@ } }, { - "id": 1285, + "id": 1290, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -79,36 +80,52 @@ ], "type": { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1287, + "id": 1292, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -128,7 +145,7 @@ { "type": "reflection", "declaration": { - "id": 1288, + "id": 1293, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -145,24 +162,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1286, + "id": 1291, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 31, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L31" } ], "type": { @@ -171,7 +194,7 @@ }, "overwrites": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -179,39 +202,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1281] + "children": [1286] }, { "title": "Properties", - "kind": 1024, - "children": [1287, 1286] + "children": [1292, 1291] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 30, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L30" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] }, { - "id": 1270, + "id": 1275, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1271, + "id": 1276, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -220,19 +242,20 @@ { "fileName": "src/lib/errors.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 1272, + "id": 1277, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1273, + "id": 1278, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -243,7 +266,7 @@ } }, { - "id": 1274, + "id": 1279, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -256,7 +279,7 @@ } }, { - "id": 1275, + "id": 1280, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -271,7 +294,7 @@ ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" }, "overwrites": { @@ -286,19 +309,35 @@ } }, { - "id": 1276, + "id": 1281, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -318,7 +357,7 @@ { "type": "reflection", "declaration": { - "id": 1277, + "id": 1282, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -335,19 +374,25 @@ } }, { - "id": 1278, + "id": 1283, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" } ], "type": { @@ -368,57 +413,56 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1271] + "children": [1276] }, { "title": "Properties", - "kind": 1024, - "children": [1276, 1278] + "children": [1281, 1283] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 4, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L4" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ], "extendedBy": [ { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" }, { "type": "reference", - "id": 1290, + "id": 1295, "name": "AuthUnknownError" }, { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1338, + "id": 1343, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -427,19 +471,20 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "signatures": [ { - "id": 1339, + "id": 1344, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1340, + "id": 1345, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -450,7 +495,7 @@ } }, { - "id": 1341, + "id": 1346, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -465,14 +510,14 @@ { "type": "reflection", "declaration": { - "id": 1342, + "id": 1347, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1344, + "id": 1349, "name": "code", "kind": 1024, "kindString": "Property", @@ -481,7 +526,8 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 57 + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { @@ -490,7 +536,7 @@ } }, { - "id": 1343, + "id": 1348, "name": "error", "kind": 1024, "kindString": "Property", @@ -499,7 +545,8 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { @@ -511,8 +558,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1344, 1343] + "children": [1349, 1348] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ] } @@ -524,36 +578,52 @@ ], "type": { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1361, + "id": 1366, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -573,7 +643,7 @@ { "type": "reflection", "declaration": { - "id": 1362, + "id": 1367, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -590,12 +660,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1345, + "id": 1350, "name": "details", "kind": 1024, "kindString": "Property", @@ -604,7 +674,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -617,14 +688,14 @@ { "type": "reflection", "declaration": { - "id": 1346, + "id": 1351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1348, + "id": 1353, "name": "code", "kind": 1024, "kindString": "Property", @@ -633,7 +704,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -642,7 +714,7 @@ } }, { - "id": 1347, + "id": 1352, "name": "error", "kind": 1024, "kindString": "Property", @@ -651,7 +723,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -663,8 +736,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1348, 1347] + "children": [1353, 1352] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ] } @@ -674,7 +754,7 @@ "defaultValue": "null" }, { - "id": 1359, + "id": 1364, "name": "name", "kind": 1024, "kindString": "Property", @@ -683,7 +763,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -692,24 +773,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1360, + "id": 1365, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -718,12 +805,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } }, { - "id": 1349, + "id": 1354, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -732,12 +819,13 @@ { "fileName": "src/lib/errors.ts", "line": 95, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L95" } ], "signatures": [ { - "id": 1350, + "id": 1355, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -745,14 +833,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1351, + "id": 1356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1355, + "id": 1360, "name": "details", "kind": 1024, "kindString": "Property", @@ -761,7 +849,8 @@ { "fileName": "src/lib/errors.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L100" } ], "type": { @@ -774,14 +863,14 @@ { "type": "reflection", "declaration": { - "id": 1356, + "id": 1361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1358, + "id": 1363, "name": "code", "kind": 1024, "kindString": "Property", @@ -790,7 +879,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -799,7 +889,7 @@ } }, { - "id": 1357, + "id": 1362, "name": "error", "kind": 1024, "kindString": "Property", @@ -808,7 +898,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -820,8 +911,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1358, 1357] + "children": [1363, 1362] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ] } @@ -831,7 +929,7 @@ "defaultValue": "..." }, { - "id": 1353, + "id": 1358, "name": "message", "kind": 1024, "kindString": "Property", @@ -840,7 +938,8 @@ { "fileName": "src/lib/errors.ts", "line": 98, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L98" } ], "type": { @@ -850,7 +949,7 @@ "defaultValue": "..." }, { - "id": 1352, + "id": 1357, "name": "name", "kind": 1024, "kindString": "Property", @@ -859,7 +958,8 @@ { "fileName": "src/lib/errors.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L97" } ], "type": { @@ -869,7 +969,7 @@ "defaultValue": "..." }, { - "id": 1354, + "id": 1359, "name": "status", "kind": 1024, "kindString": "Property", @@ -878,7 +978,8 @@ { "fileName": "src/lib/errors.ts", "line": 99, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L99" } ], "type": { @@ -891,8 +992,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1355, 1353, 1352, 1354] + "children": [1360, 1358, 1357, 1359] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L96" } ] } @@ -904,44 +1012,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1338] + "children": [1343] }, { "title": "Properties", - "kind": 1024, - "children": [1361, 1345, 1359, 1360] + "children": [1366, 1350, 1364, 1365] }, { "title": "Methods", - "kind": 2048, - "children": [1349] + "children": [1354] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 88, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L88" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1329, + "id": 1334, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -950,19 +1056,20 @@ { "fileName": "src/lib/errors.ts", "line": 83, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L83" } ], "signatures": [ { - "id": 1330, + "id": 1335, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1331, + "id": 1336, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -975,36 +1082,52 @@ ], "type": { "type": "reference", - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1334, + "id": 1339, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1024,7 +1147,7 @@ { "type": "reflection", "declaration": { - "id": 1335, + "id": 1340, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1041,12 +1164,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1332, + "id": 1337, "name": "name", "kind": 1024, "kindString": "Property", @@ -1055,7 +1178,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1064,24 +1188,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1333, + "id": 1338, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1090,7 +1220,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1098,39 +1228,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1329] + "children": [1334] }, { "title": "Properties", - "kind": 1024, - "children": [1334, 1332, 1333] + "children": [1339, 1337, 1338] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 82, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L82" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1414, + "id": 1419, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1139,19 +1268,20 @@ { "fileName": "src/lib/errors.ts", "line": 162, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L162" } ], "signatures": [ { - "id": 1415, + "id": 1420, "name": "new AuthInvalidJwtError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1416, + "id": 1421, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1164,36 +1294,52 @@ ], "type": { "type": "reference", - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1419, + "id": 1424, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1213,7 +1359,7 @@ { "type": "reflection", "declaration": { - "id": 1420, + "id": 1425, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1230,12 +1376,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1417, + "id": 1422, "name": "name", "kind": 1024, "kindString": "Property", @@ -1244,7 +1390,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1253,24 +1400,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1418, + "id": 1423, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1279,7 +1432,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1287,39 +1440,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1414] + "children": [1419] }, { "title": "Properties", - "kind": 1024, - "children": [1419, 1417, 1418] + "children": [1424, 1422, 1423] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 161, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L161" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1321, + "id": 1326, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1328,48 +1480,65 @@ { "fileName": "src/lib/errors.ts", "line": 77, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L77" } ], "signatures": [ { - "id": 1322, + "id": 1327, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1325, + "id": 1330, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1389,7 +1558,7 @@ { "type": "reflection", "declaration": { - "id": 1326, + "id": 1331, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1406,12 +1575,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1323, + "id": 1328, "name": "name", "kind": 1024, "kindString": "Property", @@ -1420,7 +1589,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1429,24 +1599,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1324, + "id": 1329, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1455,7 +1631,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1463,39 +1639,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1321] + "children": [1326] }, { "title": "Properties", - "kind": 1024, - "children": [1325, 1323, 1324] + "children": [1330, 1328, 1329] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 76, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L76" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1365, + "id": 1370, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1504,19 +1679,20 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "signatures": [ { - "id": 1366, + "id": 1371, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1367, + "id": 1372, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1527,7 +1703,7 @@ } }, { - "id": 1368, + "id": 1373, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1542,14 +1718,14 @@ { "type": "reflection", "declaration": { - "id": 1369, + "id": 1374, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1371, + "id": 1376, "name": "code", "kind": 1024, "kindString": "Property", @@ -1558,7 +1734,8 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 57 + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "type": { @@ -1567,7 +1744,7 @@ } }, { - "id": 1370, + "id": 1375, "name": "error", "kind": 1024, "kindString": "Property", @@ -1576,7 +1753,8 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "type": { @@ -1588,8 +1766,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1371, 1370] + "children": [1376, 1375] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ] } @@ -1601,36 +1786,52 @@ ], "type": { "type": "reference", - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1388, + "id": 1393, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1650,7 +1851,7 @@ { "type": "reflection", "declaration": { - "id": 1389, + "id": 1394, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1667,12 +1868,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1372, + "id": 1377, "name": "details", "kind": 1024, "kindString": "Property", @@ -1681,7 +1882,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1694,14 +1896,14 @@ { "type": "reflection", "declaration": { - "id": 1373, + "id": 1378, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1375, + "id": 1380, "name": "code", "kind": 1024, "kindString": "Property", @@ -1710,7 +1912,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1719,7 +1922,7 @@ } }, { - "id": 1374, + "id": 1379, "name": "error", "kind": 1024, "kindString": "Property", @@ -1728,7 +1931,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1740,8 +1944,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1375, 1374] + "children": [1380, 1379] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ] } @@ -1751,7 +1962,7 @@ "defaultValue": "null" }, { - "id": 1386, + "id": 1391, "name": "name", "kind": 1024, "kindString": "Property", @@ -1760,7 +1971,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1769,24 +1981,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1387, + "id": 1392, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1795,12 +2013,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } }, { - "id": 1376, + "id": 1381, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1809,12 +2027,13 @@ { "fileName": "src/lib/errors.ts", "line": 119, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L119" } ], "signatures": [ { - "id": 1377, + "id": 1382, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1822,14 +2041,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1378, + "id": 1383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1382, + "id": 1387, "name": "details", "kind": 1024, "kindString": "Property", @@ -1838,7 +2057,8 @@ { "fileName": "src/lib/errors.ts", "line": 124, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L124" } ], "type": { @@ -1851,14 +2071,14 @@ { "type": "reflection", "declaration": { - "id": 1383, + "id": 1388, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1385, + "id": 1390, "name": "code", "kind": 1024, "kindString": "Property", @@ -1867,7 +2087,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1876,7 +2097,7 @@ } }, { - "id": 1384, + "id": 1389, "name": "error", "kind": 1024, "kindString": "Property", @@ -1885,7 +2106,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1897,8 +2119,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1385, 1384] + "children": [1390, 1389] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ] } @@ -1908,7 +2137,7 @@ "defaultValue": "..." }, { - "id": 1380, + "id": 1385, "name": "message", "kind": 1024, "kindString": "Property", @@ -1917,7 +2146,8 @@ { "fileName": "src/lib/errors.ts", "line": 122, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L122" } ], "type": { @@ -1927,7 +2157,7 @@ "defaultValue": "..." }, { - "id": 1379, + "id": 1384, "name": "name", "kind": 1024, "kindString": "Property", @@ -1936,7 +2166,8 @@ { "fileName": "src/lib/errors.ts", "line": 121, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L121" } ], "type": { @@ -1946,7 +2177,7 @@ "defaultValue": "..." }, { - "id": 1381, + "id": 1386, "name": "status", "kind": 1024, "kindString": "Property", @@ -1955,7 +2186,8 @@ { "fileName": "src/lib/errors.ts", "line": 123, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L123" } ], "type": { @@ -1968,8 +2200,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1382, 1380, 1379, 1381] + "children": [1387, 1385, 1384, 1386] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 120, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L120" } ] } @@ -1981,44 +2220,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1365] + "children": [1370] }, { "title": "Properties", - "kind": 1024, - "children": [1388, 1372, 1386, 1387] + "children": [1393, 1377, 1391, 1392] }, { "title": "Methods", - "kind": 2048, - "children": [1376] + "children": [1381] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 111, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L111" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1392, + "id": 1397, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2027,19 +2264,20 @@ { "fileName": "src/lib/errors.ts", "line": 130, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L130" } ], "signatures": [ { - "id": 1393, + "id": 1398, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1394, + "id": 1399, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2050,7 +2288,7 @@ } }, { - "id": 1395, + "id": 1400, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2063,36 +2301,52 @@ ], "type": { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1398, + "id": 1403, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2112,7 +2366,7 @@ { "type": "reflection", "declaration": { - "id": 1399, + "id": 1404, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2129,12 +2383,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1396, + "id": 1401, "name": "name", "kind": 1024, "kindString": "Property", @@ -2143,7 +2397,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2152,24 +2407,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1397, + "id": 1402, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2178,7 +2439,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2186,39 +2447,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1392] + "children": [1397] }, { "title": "Properties", - "kind": 1024, - "children": [1398, 1396, 1397] + "children": [1403, 1401, 1402] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 129, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L129" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1313, + "id": 1318, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2227,48 +2487,65 @@ { "fileName": "src/lib/errors.ts", "line": 67, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L67" } ], "signatures": [ { - "id": 1314, + "id": 1319, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1317, + "id": 1322, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2288,7 +2565,7 @@ { "type": "reflection", "declaration": { - "id": 1318, + "id": 1323, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2305,12 +2582,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1315, + "id": 1320, "name": "name", "kind": 1024, "kindString": "Property", @@ -2319,7 +2596,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2328,24 +2606,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1316, + "id": 1321, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2354,7 +2638,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2362,39 +2646,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1313] + "children": [1318] }, { "title": "Properties", - "kind": 1024, - "children": [1317, 1315, 1316] + "children": [1322, 1320, 1321] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 66, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L66" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1290, + "id": 1295, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1291, + "id": 1296, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2403,19 +2686,20 @@ { "fileName": "src/lib/errors.ts", "line": 48, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L48" } ], "signatures": [ { - "id": 1292, + "id": 1297, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1293, + "id": 1298, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2426,7 +2710,7 @@ } }, { - "id": 1294, + "id": 1299, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2439,36 +2723,52 @@ ], "type": { "type": "reference", - "id": 1290, + "id": 1295, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1296, + "id": 1301, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2488,7 +2788,7 @@ { "type": "reflection", "declaration": { - "id": 1297, + "id": 1302, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2505,12 +2805,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1295, + "id": 1300, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2519,7 +2819,8 @@ { "fileName": "src/lib/errors.ts", "line": 46, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L46" } ], "type": { @@ -2528,19 +2829,25 @@ } }, { - "id": 1298, + "id": 1303, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" } ], "type": { @@ -2558,7 +2865,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -2566,42 +2873,46 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1291] + "children": [1296] }, { "title": "Properties", - "kind": 1024, - "children": [1296, 1295, 1298] + "children": [1301, 1300, 1303] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 45, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L45" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] }, { - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." + "summary": [ + { + "kind": "text", + "text": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." + } + ] }, "children": [ { - "id": 1402, + "id": 1407, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2610,19 +2921,20 @@ { "fileName": "src/lib/errors.ts", "line": 150, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L150" } ], "signatures": [ { - "id": 1403, + "id": 1408, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1404, + "id": 1409, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2633,7 +2945,7 @@ } }, { - "id": 1405, + "id": 1410, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2644,7 +2956,7 @@ } }, { - "id": 1406, + "id": 1411, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2660,36 +2972,52 @@ ], "type": { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1410, + "id": 1415, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2709,7 +3037,7 @@ { "type": "reflection", "declaration": { - "id": 1411, + "id": 1416, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2726,12 +3054,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1408, + "id": 1413, "name": "name", "kind": 1024, "kindString": "Property", @@ -2740,7 +3068,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2749,24 +3078,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1407, + "id": 1412, "name": "reasons", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Reasons why the password is deemed weak." + "summary": [ + { + "kind": "text", + "text": "Reasons why the password is deemed weak." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 148, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L148" } ], "type": { @@ -2779,19 +3114,25 @@ } }, { - "id": 1409, + "id": 1414, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2800,7 +3141,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2808,39 +3149,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1402] + "children": [1407] }, { "title": "Properties", - "kind": 1024, - "children": [1410, 1408, 1407, 1409] + "children": [1415, 1413, 1412, 1414] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 144, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L144" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1300, + "id": 1305, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1301, + "id": 1306, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2849,19 +3189,20 @@ { "fileName": "src/lib/errors.ts", "line": 59, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L59" } ], "signatures": [ { - "id": 1302, + "id": 1307, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1303, + "id": 1308, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2872,7 +3213,7 @@ } }, { - "id": 1304, + "id": 1309, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2883,7 +3224,7 @@ } }, { - "id": 1305, + "id": 1310, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2894,7 +3235,7 @@ } }, { - "id": 1306, + "id": 1311, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -2916,36 +3257,52 @@ ], "type": { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1309, + "id": 1314, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2965,7 +3322,7 @@ { "type": "reflection", "declaration": { - "id": 1310, + "id": 1315, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2982,12 +3339,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1307, + "id": 1312, "name": "name", "kind": 1024, "kindString": "Property", @@ -2996,7 +3353,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -3009,19 +3367,25 @@ } }, { - "id": 1308, + "id": 1313, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -3030,7 +3394,7 @@ }, "overwrites": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -3038,68 +3402,67 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1301] + "children": [1306] }, { "title": "Properties", - "kind": 1024, - "children": [1309, 1307, 1308] + "children": [1314, 1312, 1313] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 55, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L55" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" }, { "type": "reference", - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError" } ] @@ -3121,7 +3484,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L37" } ], "signatures": [ @@ -3159,7 +3523,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 46, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L46" } ], "type": { @@ -3170,6 +3535,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -3189,15 +3561,15 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } @@ -3212,9 +3584,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3223,14 +3595,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3249,7 +3621,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" } ], "type": { @@ -3260,6 +3633,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -3296,7 +3677,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L42" } ], "type": { @@ -3308,9 +3690,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [11, 7, 6] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 41, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L41" + } ] } } @@ -3331,18 +3720,24 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains all MFA administration methods." + "summary": [ + { + "kind": "text", + "text": "Contains all MFA administration methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L29" } ], "type": { "type": "reference", - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi" } }, @@ -3356,7 +3751,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L160" } ], "signatures": [ @@ -3367,7 +3763,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -3392,9 +3801,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3409,7 +3818,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 280, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L280" } ], "signatures": [ @@ -3420,7 +3830,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key." + "summary": [ + { + "kind": "text", + "text": "Delete a user. Requires a " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key." + } + ] }, "parameters": [ { @@ -3430,7 +3853,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user id you want to remove." + "summary": [ + { + "kind": "text", + "text": "The user id you want to remove." + } + ] }, "type": { "type": "intrinsic", @@ -3444,7 +3872,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -3462,9 +3903,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3479,7 +3920,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 126, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L126" } ], "signatures": [ @@ -3490,7 +3932,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." + "summary": [ + { + "kind": "text", + "text": "Generates email links and OTPs to be sent via a custom email provider." + } + ] }, "parameters": [ { @@ -3501,7 +3948,7 @@ "flags": {}, "type": { "type": "reference", - "id": 1007, + "id": 1012, "name": "GenerateLinkParams" } } @@ -3511,13 +3958,13 @@ "typeArguments": [ { "type": "reference", - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3532,7 +3979,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 229, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L229" } ], "signatures": [ @@ -3543,7 +3991,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get user by id." + "summary": [ + { + "kind": "text", + "text": "Get user by id." + } + ] }, "parameters": [ { @@ -3553,7 +4006,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -3570,9 +4036,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3587,7 +4053,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 93, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L93" } ], "signatures": [ @@ -3598,7 +4065,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends an invite link to an email address." + "summary": [ + { + "kind": "text", + "text": "Sends an invite link to an email address." + } + ] }, "parameters": [ { @@ -3608,7 +4080,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -3622,7 +4099,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Additional options to be included when inviting.\n" + "summary": [ + { + "kind": "text", + "text": "Additional options to be included when inviting." + } + ] }, "type": { "type": "reflection", @@ -3642,13 +4124,27 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." + "summary": [ + { + "kind": "text", + "text": "A custom data object to store additional metadata about the user. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.user_metadata`" + }, + { + "kind": "text", + "text": " column." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L97" } ], "type": { @@ -3665,13 +4161,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L100" } ], "type": { @@ -3683,9 +4185,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [39, 40] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 95, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L95" + } ] } }, @@ -3701,9 +4210,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3718,7 +4227,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 182, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L182" } ], "signatures": [ @@ -3729,8 +4239,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -3742,11 +4264,32 @@ "isOptional": true }, "comment": { - "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" + "summary": [ + { + "kind": "text", + "text": "An object which supports " + }, + { + "kind": "code", + "text": "`page`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`perPage`" + }, + { + "kind": "text", + "text": " as numbers, to alter the paginated results." + } + ] }, "type": { "type": "reference", - "id": 1179, + "id": 1184, "name": "PageParams" } } @@ -3776,7 +4319,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -3801,7 +4345,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -3819,7 +4364,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -3835,15 +4381,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [54, 53] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, { "type": "reference", - "id": 1172, + "id": 1177, "name": "Pagination" } ] @@ -3859,7 +4412,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -3871,9 +4425,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [51, 55] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, @@ -3896,7 +4457,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -3918,7 +4480,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -3929,9 +4492,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [59] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } @@ -3946,12 +4516,13 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -3959,18 +4530,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [57, 60] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3985,7 +4563,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 62, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L62" } ], "signatures": [ @@ -3996,7 +4575,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes a logged-in session." + "summary": [ + { + "kind": "text", + "text": "Removes a logged-in session." + } + ] }, "parameters": [ { @@ -4006,7 +4590,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A valid, logged-in JWT." + "summary": [ + { + "kind": "text", + "text": "A valid, logged-in JWT." + } + ] }, "type": { "type": "intrinsic", @@ -4020,7 +4609,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The logout sope.\n" + "summary": [ + { + "kind": "text", + "text": "The logout sope." + } + ] }, "type": { "type": "union", @@ -4064,7 +4658,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -4082,7 +4677,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -4094,7 +4690,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -4104,16 +4700,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [32, 33] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4128,7 +4731,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 253, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L253" } ], "signatures": [ @@ -4139,7 +4743,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "summary": [ + { + "kind": "text", + "text": "Updates the user data." + } + ] }, "parameters": [ { @@ -4160,7 +4769,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "reference", @@ -4178,9 +4800,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4189,17 +4811,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [2] }, { "title": "Properties", - "kind": 1024, "children": [16] }, { "title": "Methods", - "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], @@ -4207,7 +4826,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L27" } ] }, @@ -4228,7 +4848,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L240" } ], "signatures": [ @@ -4239,7 +4860,12 @@ "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Create a new client for use in the browser." + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] }, "parameters": [ { @@ -4270,13 +4896,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + "summary": [ + { + "kind": "text", + "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 167, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L167" } ], "type": { @@ -4292,18 +4924,24 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the MFA methods." + "summary": [ + { + "kind": "text", + "text": "Namespace for the MFA methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L171" } ], "type": { "type": "reference", - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi" } }, @@ -4317,7 +4955,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 651, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L651" } ], "signatures": [ @@ -4328,7 +4967,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + } + ] }, "parameters": [ { @@ -4352,9 +4996,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4369,7 +5013,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3181" } ], "signatures": [ @@ -4380,8 +5025,40 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n`/.well-known/jwks.json` which is often cached, resulting in significantly\nfaster responses. Prefer this method over {@link #getUser} which always\nsends a request to the Auth server for each JWT.", - "text": "If the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to {@link\n#getUser}) to verify the JWT.\n" + "summary": [ + { + "kind": "text", + "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" + }, + { + "kind": "code", + "text": "`/.well-known/jwks.json`" + }, + { + "kind": "text", + "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": ") to verify the JWT." + } + ] }, "parameters": [ { @@ -4393,7 +5070,22 @@ "isOptional": true }, "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\n can obtain from {@link #getSession}." + "summary": [ + { + "kind": "text", + "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getSession", + "target": 0 + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -4407,7 +5099,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Various additional options that allow you to customize the\n behavior of this method.\n" + "summary": [ + { + "kind": "text", + "text": "Various additional options that allow you to customize the\n behavior of this method." + } + ] }, "type": { "type": "reflection", @@ -4427,13 +5124,35 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` the `exp` claim will not be validated against the current time." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " the " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " claim will not be validated against the current time." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3190, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3190" } ], "type": { @@ -4450,13 +5169,19 @@ "isOptional": true }, "comment": { - "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + "summary": [ + { + "kind": "text", + "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { @@ -4478,14 +5203,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -4494,9 +5220,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [532] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3193, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" + } ] } } @@ -4510,10 +5243,16 @@ "isOptional": true }, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Please use options.jwks instead.\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Please use options.jwks instead." + } + ] } ] }, @@ -4521,14 +5260,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3187" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -4537,9 +5277,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [529, 530, 528] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3183, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3183" + } ] } }, @@ -4571,7 +5318,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { @@ -4593,12 +5341,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1239, + "id": 1244, "name": "JwtPayload" } }, @@ -4612,12 +5361,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 36 + "character": 36, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1224, + "id": 1229, "name": "JwtHeader" } }, @@ -4631,23 +5381,31 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 55 + "character": 55, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, "children": [536, 537, 538] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3197, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" + } ] } } @@ -4662,7 +5420,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3198, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3198" } ], "type": { @@ -4674,9 +5433,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [534, 539] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3196, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3196" + } ] } }, @@ -4699,7 +5465,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { @@ -4717,12 +5484,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -4730,9 +5498,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [541, 542] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3200, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" + } ] } }, @@ -4755,7 +5530,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -4773,7 +5549,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -4785,18 +5562,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [544, 545] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3201, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4811,7 +5595,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1355, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1355" } ], "signatures": [ @@ -4822,8 +5607,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session, refreshing it if necessary.", - "text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use {@link #getUser()} instead.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser()", + "target": 0 + }, + { + "kind": "text", + "text": " instead." + } + ] }, "type": { "type": "reference", @@ -4850,7 +5649,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1448, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" } ], "type": { @@ -4872,7 +5672,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1449, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1449" } ], "type": { @@ -4885,9 +5686,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [237] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1448, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" + } ] } } @@ -4902,7 +5710,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1451, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1451" } ], "type": { @@ -4914,9 +5723,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [235, 238] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1447, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1447" + } ] } }, @@ -4939,7 +5755,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1454, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" } ], "type": { @@ -4961,7 +5778,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1455, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1455" } ], "type": { @@ -4973,9 +5791,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [242] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1454, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" + } ] } } @@ -4990,12 +5815,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 1457, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1457" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -5003,9 +5829,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [240, 243] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1453, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1453" + } ] } }, @@ -5028,7 +5861,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1460, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" } ], "type": { @@ -5050,7 +5884,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1461, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1461" } ], "type": { @@ -5062,9 +5897,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [247] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1460, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" + } ] } } @@ -5079,7 +5921,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1463, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1463" } ], "type": { @@ -5091,18 +5934,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [245, 248] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1459, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1459" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5117,7 +5967,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1599, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1599" } ], "signatures": [ @@ -5128,7 +5979,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + "summary": [ + { + "kind": "text", + "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + } + ] }, "parameters": [ { @@ -5140,7 +5996,12 @@ "isOptional": true }, "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\n" + "summary": [ + { + "kind": "text", + "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." + } + ] }, "type": { "type": "intrinsic", @@ -5157,9 +6018,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5174,7 +6035,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2157, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2157" } ], "signatures": [ @@ -5185,7 +6047,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets all the identities linked to a user." + "summary": [ + { + "kind": "text", + "text": "Gets all the identities linked to a user." + } + ] }, "type": { "type": "reference", @@ -5212,7 +6079,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" } ], "type": { @@ -5234,7 +6102,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2160, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2160" } ], "type": { @@ -5250,9 +6119,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [409] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2159, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" + } ] } } @@ -5267,7 +6143,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2162, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2162" } ], "type": { @@ -5279,9 +6156,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [407, 410] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2158, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2158" + } ] } }, @@ -5304,7 +6188,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { @@ -5322,12 +6207,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -5335,18 +6221,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [412, 413] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2164, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5361,7 +6254,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 353, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L353" } ], "signatures": [ @@ -5372,20 +6266,25 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + "summary": [ + { + "kind": "text", + "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1162, + "id": 1167, "name": "InitializeResult" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5400,7 +6299,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2181" } ], "signatures": [ @@ -5411,7 +6311,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -5422,7 +6327,7 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials" } } @@ -5436,9 +6341,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5453,7 +6358,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2055, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2055" } ], "signatures": [ @@ -5464,7 +6370,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Receive a notification every time an auth event happens." + "summary": [ + { + "kind": "text", + "text": "Receive a notification every time an auth event happens." + } + ] }, "parameters": [ { @@ -5474,7 +6385,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\n" + "summary": [ + { + "kind": "text", + "text": "A callback function to be invoked when an auth event happens." + } + ] }, "type": { "type": "reflection", @@ -5484,6 +6400,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2056, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2056" + } + ], "signatures": [ { "id": 380, @@ -5541,9 +6465,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } ] } @@ -5572,7 +6496,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -5594,7 +6519,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -5607,9 +6533,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [386] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2058, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" + } ] } } @@ -5618,9 +6551,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [384] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2057, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2057" + } ] } } @@ -5637,7 +6577,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1271, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1271" } ], "signatures": [ @@ -5648,7 +6589,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + "summary": [ + { + "kind": "text", + "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + } + ] }, "type": { "type": "reference", @@ -5659,9 +6605,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5676,7 +6622,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "signatures": [ @@ -5687,7 +6634,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -5699,7 +6651,12 @@ "isOptional": true }, "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session. If passed in, it must contain a refresh token." + } + ] }, "type": { "type": "reflection", @@ -5720,7 +6677,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "type": { @@ -5732,9 +6690,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [329] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1804, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" + } ] } } @@ -5749,9 +6714,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5766,7 +6731,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1306, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1306" } ], "signatures": [ @@ -5777,7 +6743,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + "summary": [ + { + "kind": "text", + "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + } + ] }, "parameters": [ { @@ -5788,7 +6759,7 @@ "flags": {}, "type": { "type": "reference", - "id": 955, + "id": 960, "name": "ResendParams" } } @@ -5802,9 +6773,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5819,7 +6790,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2111" } ], "signatures": [ @@ -5830,7 +6802,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Sends a password reset request to an email address. This method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -5840,7 +6817,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -5871,13 +6853,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2115" } ], "type": { @@ -5894,13 +6882,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL to send the user to after they click the password reset link." + "summary": [ + { + "kind": "text", + "text": "The URL to send the user to after they click the password reset link." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2114" } ], "type": { @@ -5912,9 +6906,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [396, 395] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2113, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2113" + } ] } }, @@ -5946,7 +6947,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2119" } ], "type": { @@ -5970,7 +6972,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2120, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2120" } ], "type": { @@ -5982,9 +6985,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [398, 400] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2118, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2118" + } ] } }, @@ -6007,7 +7017,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { @@ -6025,12 +7036,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -6038,18 +7050,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [402, 403] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2122, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6064,7 +7083,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1729, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" } ], "signatures": [ @@ -6075,7 +7095,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -6085,7 +7110,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The current session that minimally contains an access token and refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session that minimally contains an access token and refresh token." + } + ] }, "type": { "type": "reflection", @@ -6106,7 +7136,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1730, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1730" } ], "type": { @@ -6124,7 +7155,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1731, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1731" } ], "type": { @@ -6136,9 +7168,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [317, 318] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1729, + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" + } ] } } @@ -6153,9 +7192,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6170,7 +7209,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 456, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L456" } ], "signatures": [ @@ -6181,8 +7221,23 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new anonymous user.", - "returns": "A session where the is_anonymous claim in the access token JWT set to true\n" + "summary": [ + { + "kind": "text", + "text": "Creates a new anonymous user." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A session where the is_anonymous claim in the access token JWT set to true" + } + ] + } + ] }, "parameters": [ { @@ -6195,7 +7250,7 @@ }, "type": { "type": "reference", - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials" } } @@ -6209,9 +7264,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6226,7 +7281,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1064, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1064" } ], "signatures": [ @@ -6237,7 +7293,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + "summary": [ + { + "kind": "text", + "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + } + ] }, "parameters": [ { @@ -6248,7 +7309,7 @@ "flags": {}, "type": { "type": "reference", - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials" } } @@ -6262,9 +7323,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6279,7 +7340,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 639, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L639" } ], "signatures": [ @@ -6290,7 +7352,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -6301,7 +7368,7 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials" } } @@ -6315,9 +7382,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6332,7 +7399,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1119" } ], "signatures": [ @@ -6343,8 +7411,28 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).", - "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" + "summary": [ + { + "kind": "text", + "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " + }, + { + "kind": "code", + "text": "`{{ .ConfirmationURL }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " + }, + { + "kind": "code", + "text": "`{{ .Token }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed." + } + ] }, "parameters": [ { @@ -6355,7 +7443,7 @@ "flags": {}, "type": { "type": "reference", - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials" } } @@ -6369,9 +7457,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6386,7 +7474,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 576, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L576" } ], "signatures": [ @@ -6397,8 +7486,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.", - "text": "Be aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login.\n" + "summary": [ + { + "kind": "text", + "text": "Log in an existing user with an email and password or phone and password.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." + } + ] }, "parameters": [ { @@ -6409,7 +7502,7 @@ "flags": {}, "type": { "type": "reference", - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials" } } @@ -6423,9 +7516,9 @@ "name": "AuthTokenResponsePassword" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6440,7 +7533,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1233, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1233" } ], "signatures": [ @@ -6451,8 +7545,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", - "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n" + "summary": [ + { + "kind": "text", + "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." + } + ] }, "parameters": [ { @@ -6463,7 +7561,7 @@ "flags": {}, "type": { "type": "reference", - "id": 969, + "id": 974, "name": "SignInWithSSO" } } @@ -6477,9 +7575,9 @@ "name": "SSOResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6494,7 +7592,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 666, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L666" } ], "signatures": [ @@ -6505,11 +7604,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side.", - "tags": [ + "summary": [ { - "tag": "reference", - "text": "https://eips.ethereum.org/EIPS/eip-4361\n" + "kind": "text", + "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." + } + ], + "blockTags": [ + { + "tag": "@reference", + "content": [ + { + "kind": "text", + "text": "https://eips.ethereum.org/EIPS/eip-4361" + } + ] } ] }, @@ -6522,7 +7631,7 @@ "flags": {}, "type": { "type": "reference", - "id": 932, + "id": 937, "name": "Web3Credentials" } } @@ -6552,7 +7661,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -6574,7 +7684,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -6593,7 +7704,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -6606,9 +7718,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [166, 167] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 668, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" + } ] } } @@ -6623,7 +7742,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 669, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L669" } ], "type": { @@ -6635,9 +7755,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [164, 168] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 667, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L667" + } ] } }, @@ -6660,7 +7787,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -6682,7 +7810,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -6700,7 +7829,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -6712,9 +7842,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [172, 173] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } @@ -6729,12 +7866,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -6742,18 +7880,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [170, 174] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6768,7 +7913,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "signatures": [ @@ -6779,27 +7925,71 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n" - }, - "parameters": [ - { - "id": 368, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 1183, - "name": "SignOut" + "summary": [ + { + "kind": "text", + "text": "Inside a browser context, " }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ + { + "kind": "code", + "text": "`signOut()`" + }, + { + "kind": "text", + "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " + }, + { + "kind": "code", + "text": "`\"SIGNED_OUT\"`" + }, + { + "kind": "text", + "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " + }, + { + "kind": "code", + "text": "`auth.api.signOut(JWT: string)`" + }, + { + "kind": "text", + "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " + }, + { + "kind": "code", + "text": "`others`" + }, + { + "kind": "text", + "text": " scope, no " + }, + { + "kind": "code", + "text": "`SIGNED_OUT`" + }, + { + "kind": "text", + "text": " event is fired!" + } + ] + }, + "parameters": [ + { + "id": 368, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1188, + "name": "SignOut" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ { "type": "reflection", "declaration": { @@ -6819,7 +8009,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 67 + "character": 67, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "type": { @@ -6831,7 +8022,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -6841,16 +8032,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [370] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2011, + "character": 65, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6865,7 +8063,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 499, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L499" } ], "signatures": [ @@ -6876,9 +8075,32 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "Be aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\n", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A logged-in session if the server has \"autoconfirm\" ON" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A user if the server has \"autoconfirm\" OFF" + } + ] + } + ] }, "parameters": [ { @@ -6889,7 +8111,7 @@ "flags": {}, "type": { "type": "reference", - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials" } } @@ -6903,9 +8125,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6920,7 +8142,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2698, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2698" } ], "signatures": [ @@ -6931,8 +8154,26 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.", - "text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "summary": [ + { + "kind": "text", + "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClientOptions#autoRefreshToken" + }, + { + "kind": "text", + "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "#stopAutoRefresh" + } + ] }, "type": { "type": "reference", @@ -6942,9 +8183,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6959,7 +8200,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2711, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2711" } ], "signatures": [ @@ -6970,8 +8212,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).", - "text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n" + "summary": [ + { + "kind": "text", + "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#startAutoRefresh", + "target": 0 + }, + { + "kind": "text", + "text": " for more details." + } + ] }, "type": { "type": "reference", @@ -6981,9 +8237,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6998,7 +8254,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2217, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2217" } ], "signatures": [ @@ -7009,7 +8266,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + "summary": [ + { + "kind": "text", + "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + } + ] }, "parameters": [ { @@ -7050,7 +8312,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2219, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2219" } ], "type": { @@ -7074,7 +8337,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2220, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2220" } ], "type": { @@ -7086,9 +8350,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [421, 423] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2218, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2218" + } ] } }, @@ -7111,7 +8382,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { @@ -7129,12 +8401,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -7142,18 +8415,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [425, 426] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2222, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7168,7 +8448,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1660, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1660" } ], "signatures": [ @@ -7179,7 +8460,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates user data for a logged in user." + "summary": [ + { + "kind": "text", + "text": "Updates user data for a logged in user." + } + ] }, "parameters": [ { @@ -7221,7 +8507,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1663, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1663" } ], "type": { @@ -7233,9 +8520,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [306] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1662, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1662" + } ] } }, @@ -7251,9 +8545,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7268,7 +8562,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1172, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1172" } ], "signatures": [ @@ -7279,7 +8574,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + "summary": [ + { + "kind": "text", + "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + } + ] }, "parameters": [ { @@ -7290,7 +8590,7 @@ "flags": {}, "type": { "type": "reference", - "id": 933, + "id": 938, "name": "VerifyOtpParams" } } @@ -7304,9 +8604,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7315,17 +8615,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [80] }, { "title": "Properties", - "kind": 1024, "children": [84, 85] }, { "title": "Methods", - "kind": 2048, "children": [ 157, 523, 232, 295, 404, 141, 414, 376, 225, 325, 229, 390, 313, 145, 213, 154, 216, 151, 222, 160, 366, 148, 472, 474, 417, 301, 219 @@ -7336,7 +8633,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 158, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L158" } ] }, @@ -7353,6 +8651,14 @@ "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 26, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L26" + } + ], "signatures": [ { "id": 558, @@ -7402,7 +8708,8 @@ { "fileName": "src/lib/locks.ts", "line": 24, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L24" } ], "type": { @@ -7419,12 +8726,10 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [557] }, { "title": "Properties", - "kind": 1024, "children": [560] } ], @@ -7432,7 +8737,8 @@ { "fileName": "src/lib/locks.ts", "line": 31, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L31" } ], "extendedTypes": [ @@ -7449,12 +8755,27 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "An authentication methord reference (AMR) entry.", - "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" + "kind": "text", + "text": "An authentication methord reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "." + } + ] } ] }, @@ -7466,13 +8787,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Authentication method name." + "summary": [ + { + "kind": "text", + "text": "Authentication method name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 283, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L283" } ], "type": { @@ -7523,13 +8850,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + "summary": [ + { + "kind": "text", + "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 289, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L289" } ], "type": { @@ -7541,7 +8874,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [725, 727] } ], @@ -7549,7 +8881,8 @@ { "fileName": "src/lib/types.ts", "line": 281, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L281" } ] }, @@ -7569,14 +8902,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -7593,14 +8947,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -7617,13 +8976,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -7644,14 +9009,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -7668,14 +9038,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -7692,14 +9083,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -7720,13 +9116,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -7747,14 +9149,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -7771,13 +9186,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -7798,14 +9219,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -7822,14 +9248,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -7846,14 +9309,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -7865,7 +9349,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788] } ], @@ -7873,7 +9356,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -7890,9 +9374,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] }, @@ -7903,19 +9387,58 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "A MFA factor.", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#listFactors}" - }, + "kind": "text", + "text": "A MFA factor." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAAdminApi#listFactors}\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "listFactors", + "target": 1128 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueMFAAdminApi#listFactors" + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -7930,7 +9453,8 @@ { "fileName": "src/lib/types.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L327" } ], "type": { @@ -7945,13 +9469,35 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of factor. `totp` and `phone` supported with this version" + "summary": [ + { + "kind": "text", + "text": "Type of factor. " + }, + { + "kind": "code", + "text": "`totp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`phone`" + }, + { + "kind": "text", + "text": " supported with this version" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L322" } ], "type": { @@ -7996,13 +9542,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful to disambiguate between multiple factors." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L317" } ], "type": { @@ -8017,13 +9569,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor." + "summary": [ + { + "kind": "text", + "text": "ID of the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 314, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L314" } ], "type": { @@ -8038,13 +9596,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor's status." + "summary": [ + { + "kind": "text", + "text": "Factor's status." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 325, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L325" } ], "type": { @@ -8071,7 +9635,8 @@ { "fileName": "src/lib/types.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L328" } ], "type": { @@ -8083,7 +9648,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [746, 743, 742, 741, 745, 747] } ], @@ -8091,19 +9655,20 @@ { "fileName": "src/lib/types.ts", "line": 312, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L312" } ] }, { - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1005, + "id": 1010, "name": "data", "kind": 1024, "kindString": "Property", @@ -8111,14 +9676,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] + }, + "sources": [ + { "fileName": "src/lib/types.ts", "line": 851, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L851" } ], "type": { @@ -8127,7 +9713,7 @@ } }, { - "id": 1006, + "id": 1011, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -8135,13 +9721,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link generated." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link generated." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 853, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L853" } ], "type": { @@ -8153,70 +9745,95 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1005, 1006] + "children": [1010, 1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 845, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L845" } ] }, { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams" } } @@ -8226,43 +9843,56 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams" } } @@ -8272,13 +9902,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8287,54 +9917,72 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] }, { - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication API." + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication API." + } + ] }, "children": [ { - "id": 1111, + "id": 1116, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1058, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1058" + } + ], "signatures": [ { - "id": 1112, + "id": 1117, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + "summary": [ + { + "kind": "text", + "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + } + ] }, "parameters": [ { - "id": 1113, + "id": 1118, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1038, + "id": 1043, "name": "MFAChallengeParams" } } @@ -8344,43 +9992,56 @@ "typeArguments": [ { "type": "reference", - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1120, + "id": 1125, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1076, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1076" + } + ], "signatures": [ { - "id": 1121, + "id": 1126, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1122, + "id": 1127, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams" } } @@ -8390,44 +10051,84 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1104, + "id": 1109, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1050, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1050" + }, + { + "fileName": "src/lib/types.ts", + "line": 1051, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1051" + }, + { + "fileName": "src/lib/types.ts", + "line": 1052, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1052" + } + ], "signatures": [ { - "id": 1105, + "id": 1110, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + "summary": [ + { + "kind": "text", + "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " + }, + { + "kind": "code", + "text": "`unverified`" + }, + { + "kind": "text", + "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 1106, + "id": 1111, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams" } } @@ -8437,31 +10138,31 @@ "typeArguments": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1107, + "id": 1112, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1108, + "id": 1113, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams" } } @@ -8471,31 +10172,31 @@ "typeArguments": [ { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1109, + "id": 1114, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1115, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1029, + "id": 1034, "name": "MFAEnrollParams" } } @@ -8505,77 +10206,161 @@ "typeArguments": [ { "type": "reference", - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1125, + "id": 1130, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1101, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1101" + } + ], "signatures": [ { - "id": 1126, + "id": 1131, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + "summary": [ + { + "kind": "text", + "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " + }, + { + "kind": "code", + "text": "`aal1`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1123, + "id": 1128, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1086, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1086" + } + ], "signatures": [ { - "id": 1124, + "id": 1129, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, + "kind": "text", + "text": "Returns the list of MFA factors enabled for this user." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getUser", + "target": 295 + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -8584,43 +10369,72 @@ "typeArguments": [ { "type": "reference", - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1117, + "id": 1122, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1070, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1070" + } + ], "signatures": [ { - "id": 1118, + "id": 1123, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + "summary": [ + { + "kind": "text", + "text": "Unenroll removes a MFA factor.\nA user has to have an " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " authenticator level in order to unenroll a " + }, + { + "kind": "code", + "text": "`verified`" + }, + { + "kind": "text", + "text": " factor." + } + ] }, "parameters": [ { - "id": 1119, + "id": 1124, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams" } } @@ -8630,43 +10444,56 @@ "typeArguments": [ { "type": "reference", - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1114, + "id": 1119, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1064, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1064" + } + ], "signatures": [ { - "id": 1115, + "id": 1120, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1116, + "id": 1121, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1033, + "id": 1038, "name": "MFAVerifyParams" } } @@ -8676,13 +10503,13 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8691,27 +10518,27 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1111, 1120, 1104, 1125, 1123, 1117, 1114] + "children": [1116, 1125, 1109, 1130, 1128, 1122, 1119] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1039" } ] }, { - "id": 1243, + "id": 1248, "name": "JWK", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1246, + "id": 1251, "name": "alg", "kind": 1024, "kindString": "Property", @@ -8722,7 +10549,8 @@ { "fileName": "src/lib/types.ts", "line": 1332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1332" } ], "type": { @@ -8731,7 +10559,7 @@ } }, { - "id": 1245, + "id": 1250, "name": "key_ops", "kind": 1024, "kindString": "Property", @@ -8740,7 +10568,8 @@ { "fileName": "src/lib/types.ts", "line": 1331, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1331" } ], "type": { @@ -8752,7 +10581,7 @@ } }, { - "id": 1247, + "id": 1252, "name": "kid", "kind": 1024, "kindString": "Property", @@ -8763,7 +10592,8 @@ { "fileName": "src/lib/types.ts", "line": 1333, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1333" } ], "type": { @@ -8772,7 +10602,7 @@ } }, { - "id": 1244, + "id": 1249, "name": "kty", "kind": 1024, "kindString": "Property", @@ -8781,7 +10611,8 @@ { "fileName": "src/lib/types.ts", "line": 1330, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1330" } ], "type": { @@ -8806,26 +10637,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1246, 1245, 1247, 1244] + "children": [1251, 1250, 1252, 1249] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1329, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1329" } ], "indexSignature": { - "id": 1248, + "id": 1253, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1249, + "id": 1254, "name": "key", "kind": 32768, "flags": {}, @@ -8855,13 +10686,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + "summary": [ + { + "kind": "text", + "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 252, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L252" } ], "type": { @@ -8878,13 +10715,19 @@ "isOptional": true }, "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "A timestamp of when the token will expire. Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 264, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L264" } ], "type": { @@ -8899,13 +10742,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 260, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L260" } ], "type": { @@ -8922,13 +10771,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + "summary": [ + { + "kind": "text", + "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L248" } ], "type": { @@ -8954,13 +10809,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + "summary": [ + { + "kind": "text", + "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 243, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L243" } ], "type": { @@ -8984,13 +10845,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "A one-time used refresh token that never expires." + "summary": [ + { + "kind": "text", + "text": "A one-time used refresh token that never expires." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 256, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L256" } ], "type": { @@ -9008,7 +10875,8 @@ { "fileName": "src/lib/types.ts", "line": 265, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L265" } ], "type": { @@ -9023,13 +10891,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + "summary": [ + { + "kind": "text", + "text": "When using a separate user storage, accessing properties of this object will throw an error." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 270, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L270" } ], "type": { @@ -9042,7 +10916,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [718, 721, 720, 717, 716, 719, 722, 723] } ], @@ -9050,7 +10923,8 @@ { "fileName": "src/lib/types.ts", "line": 239, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L239" } ] }, @@ -9061,140 +10935,189 @@ "kindString": "Interface", "flags": {}, "children": [ - { - "id": 801, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 802, "name": "callback", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 483, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 803, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ + "sources": [ { - "id": 804, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 574, - "name": "AuthChangeEvent" - } - }, + "fileName": "src/lib/types.ts", + "line": 483, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" + } + ], + "signatures": [ { - "id": 805, - "name": "session", - "kind": 32768, - "kindString": "Parameter", + "id": 804, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, + "comment": { + "summary": [ { - "type": "reference", - "id": 715, - "name": "Session" + "kind": "text", + "text": "The function to call every time there is an event. eg: (eventName) => {}" } ] + }, + "parameters": [ + { + "id": 805, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 574, + "name": "AuthChangeEvent" + } + }, + { + "id": 806, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 715, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" } } - ], - "type": { - "type": "intrinsic", - "name": "void" + ] + } + } + }, + { + "id": 801, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subscriber UUID. This will be set by the client." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L479" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 806, + "id": 807, "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 487, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" } ], - "signatures": [ - { - "id": 807, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" + } + ], + "signatures": [ + { + "id": 809, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Call this to remove the listener." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [801] - }, - { - "title": "Methods", - "kind": 2048, - "children": [802, 806] + "children": [802, 801, 807] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 475, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L475" } ] }, @@ -9217,7 +11140,8 @@ { "fileName": "src/lib/types.ts", "line": 351, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L351" } ], "type": { @@ -9235,7 +11159,8 @@ { "fileName": "src/lib/types.ts", "line": 342, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L342" } ], "type": { @@ -9254,7 +11179,8 @@ { "fileName": "src/lib/types.ts", "line": 344, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L344" } ], "type": { @@ -9274,7 +11200,8 @@ { "fileName": "src/lib/types.ts", "line": 345, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L345" } ], "type": { @@ -9294,7 +11221,8 @@ { "fileName": "src/lib/types.ts", "line": 355, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L355" } ], "type": { @@ -9312,7 +11240,8 @@ { "fileName": "src/lib/types.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L354" } ], "type": { @@ -9332,7 +11261,8 @@ { "fileName": "src/lib/types.ts", "line": 365, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L365" } ], "type": { @@ -9352,7 +11282,8 @@ { "fileName": "src/lib/types.ts", "line": 352, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L352" } ], "type": { @@ -9372,7 +11303,8 @@ { "fileName": "src/lib/types.ts", "line": 347, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L347" } ], "type": { @@ -9392,7 +11324,8 @@ { "fileName": "src/lib/types.ts", "line": 356, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L356" } ], "type": { @@ -9412,7 +11345,8 @@ { "fileName": "src/lib/types.ts", "line": 364, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L364" } ], "type": { @@ -9434,7 +11368,8 @@ { "fileName": "src/lib/types.ts", "line": 341, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L341" } ], "type": { @@ -9454,7 +11389,8 @@ { "fileName": "src/lib/types.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L361" } ], "type": { @@ -9478,7 +11414,8 @@ { "fileName": "src/lib/types.ts", "line": 350, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L350" } ], "type": { @@ -9498,7 +11435,8 @@ { "fileName": "src/lib/types.ts", "line": 362, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L362" } ], "type": { @@ -9518,7 +11456,8 @@ { "fileName": "src/lib/types.ts", "line": 363, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L363" } ], "type": { @@ -9538,7 +11477,8 @@ { "fileName": "src/lib/types.ts", "line": 358, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L358" } ], "type": { @@ -9558,7 +11498,8 @@ { "fileName": "src/lib/types.ts", "line": 348, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L348" } ], "type": { @@ -9578,7 +11519,8 @@ { "fileName": "src/lib/types.ts", "line": 349, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L349" } ], "type": { @@ -9598,7 +11540,8 @@ { "fileName": "src/lib/types.ts", "line": 353, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L353" } ], "type": { @@ -9618,7 +11561,8 @@ { "fileName": "src/lib/types.ts", "line": 357, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L357" } ], "type": { @@ -9638,7 +11582,8 @@ { "fileName": "src/lib/types.ts", "line": 346, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L346" } ], "type": { @@ -9658,7 +11603,8 @@ { "fileName": "src/lib/types.ts", "line": 359, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L359" } ], "type": { @@ -9678,7 +11624,8 @@ { "fileName": "src/lib/types.ts", "line": 360, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L360" } ], "type": { @@ -9696,7 +11643,8 @@ { "fileName": "src/lib/types.ts", "line": 343, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L343" } ], "type": { @@ -9709,7 +11657,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 766, 757, 759, 760, 770, 769, 780, 767, 762, 771, 779, 756, 776, 765, 777, 778, 773, 763, 764, 768, 772, 761, 774, 775, 758 @@ -9720,7 +11667,8 @@ { "fileName": "src/lib/types.ts", "line": 340, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L340" } ] }, @@ -9743,7 +11691,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -9755,7 +11704,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -9763,7 +11711,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -9806,14 +11755,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 397, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L397" } ], "type": { @@ -9830,13 +11800,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -9853,14 +11829,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -9877,13 +11858,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -9900,13 +11887,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -9918,7 +11911,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [786, 782, 785, 784, 783] } ], @@ -9926,7 +11918,8 @@ { "fileName": "src/lib/types.ts", "line": 368, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L368" } ] }, @@ -9949,7 +11942,8 @@ { "fileName": "src/lib/types.ts", "line": 300, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L300" } ], "type": { @@ -9967,7 +11961,8 @@ { "fileName": "src/lib/types.ts", "line": 293, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L293" } ], "type": { @@ -9987,7 +11982,8 @@ { "fileName": "src/lib/types.ts", "line": 295, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" } ], "type": { @@ -9998,6 +11994,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" + } + ], "indexSignature": { "id": 733, "name": "__index", @@ -10034,7 +12038,8 @@ { "fileName": "src/lib/types.ts", "line": 298, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L298" } ], "type": { @@ -10054,7 +12059,8 @@ { "fileName": "src/lib/types.ts", "line": 301, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L301" } ], "type": { @@ -10072,7 +12078,8 @@ { "fileName": "src/lib/types.ts", "line": 299, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L299" } ], "type": { @@ -10092,7 +12099,8 @@ { "fileName": "src/lib/types.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L302" } ], "type": { @@ -10110,7 +12118,8 @@ { "fileName": "src/lib/types.ts", "line": 294, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L294" } ], "type": { @@ -10122,7 +12131,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [737, 729, 731, 735, 738, 736, 739, 730] } ], @@ -10130,7 +12138,8 @@ { "fileName": "src/lib/types.ts", "line": 292, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L292" } ] }, @@ -10144,7 +12153,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -10172,26 +12182,32 @@ } }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -10200,7 +12216,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -10211,20 +12227,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -10232,11 +12249,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -10244,7 +12266,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -10253,7 +12276,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10261,13 +12284,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -10279,27 +12308,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -10308,24 +12350,30 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" } } @@ -10333,27 +12381,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -10364,20 +12412,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -10385,11 +12434,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -10397,7 +12451,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -10406,7 +12461,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10414,13 +12469,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -10432,27 +12493,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -10461,19 +12535,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -10482,24 +12562,30 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" } } @@ -10507,39 +12593,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -10548,24 +12640,30 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" } } @@ -10573,15 +12671,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] }, @@ -10595,7 +12693,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L34" } ], "type": { @@ -10643,7 +12742,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L32" } ], "type": { @@ -10652,7 +12752,7 @@ } }, { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -10661,7 +12761,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -10679,16 +12780,17 @@ } }, { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -10696,32 +12798,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -10730,19 +12839,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -10754,31 +12869,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } } }, { - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -10786,7 +12902,8 @@ { "fileName": "src/lib/types.ts", "line": 1107, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1107" } ], "type": { @@ -10795,14 +12912,14 @@ { "type": "reflection", "declaration": { - "id": 1128, + "id": 1133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1129, + "id": 1134, "name": "data", "kind": 1024, "kindString": "Property", @@ -10811,32 +12928,39 @@ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ], "type": { "type": "reflection", "declaration": { - "id": 1130, + "id": 1135, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1131, + "id": 1136, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1111" } ], "type": { @@ -10848,22 +12972,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1131] + "children": [1136] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ] } } }, { - "id": 1132, + "id": 1137, "name": "error", "kind": 1024, "kindString": "Property", @@ -10872,7 +12996,8 @@ { "fileName": "src/lib/types.ts", "line": 1113, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1113" } ], "type": { @@ -10884,15 +13009,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1129, 1132] + "children": [1134, 1137] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1108, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1108" } ] } @@ -10900,14 +13025,14 @@ { "type": "reflection", "declaration": { - "id": 1133, + "id": 1138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1134, + "id": 1139, "name": "data", "kind": 1024, "kindString": "Property", @@ -10916,7 +13041,8 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { @@ -10925,7 +13051,7 @@ } }, { - "id": 1135, + "id": 1140, "name": "error", "kind": 1024, "kindString": "Property", @@ -10934,12 +13060,13 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -10947,15 +13074,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1134, 1135] + "children": [1139, 1140] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ] } @@ -10964,16 +13091,17 @@ } }, { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -10981,32 +13109,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -11018,31 +13153,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } } }, { - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -11050,7 +13186,8 @@ { "fileName": "src/lib/types.ts", "line": 1131, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1131" } ], "type": { @@ -11059,14 +13196,14 @@ { "type": "reflection", "declaration": { - "id": 1141, + "id": 1146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1142, + "id": 1147, "name": "data", "kind": 1024, "kindString": "Property", @@ -11075,32 +13212,39 @@ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ], "type": { "type": "reflection", "declaration": { - "id": 1143, + "id": 1148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1144, + "id": 1149, "name": "factors", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All factors attached to the user." + "summary": [ + { + "kind": "text", + "text": "All factors attached to the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1135" } ], "type": { @@ -11116,22 +13260,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1144] + "children": [1149] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ] } } }, { - "id": 1145, + "id": 1150, "name": "error", "kind": 1024, "kindString": "Property", @@ -11140,7 +13284,8 @@ { "fileName": "src/lib/types.ts", "line": 1137, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1137" } ], "type": { @@ -11152,15 +13297,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1142, 1145] + "children": [1147, 1150] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1132, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1132" } ] } @@ -11168,14 +13313,14 @@ { "type": "reflection", "declaration": { - "id": 1146, + "id": 1151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1147, + "id": 1152, "name": "data", "kind": 1024, "kindString": "Property", @@ -11184,7 +13329,8 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { @@ -11193,7 +13339,7 @@ } }, { - "id": 1148, + "id": 1153, "name": "error", "kind": 1024, "kindString": "Property", @@ -11202,12 +13348,13 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11215,15 +13362,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1147, 1148] + "children": [1152, 1153] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ] } @@ -11232,7 +13379,7 @@ } }, { - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -11241,7 +13388,8 @@ { "fileName": "src/lib/types.ts", "line": 977, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L977" } ], "type": { @@ -11250,14 +13398,14 @@ { "type": "reflection", "declaration": { - "id": 1070, + "id": 1075, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1071, + "id": 1076, "name": "data", "kind": 1024, "kindString": "Property", @@ -11266,32 +13414,39 @@ { "fileName": "src/lib/types.ts", "line": 979, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ], "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1075, + "id": 1080, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." + "summary": [ + { + "kind": "text", + "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 987, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L987" } ], "type": { @@ -11300,19 +13455,25 @@ } }, { - "id": 1073, + "id": 1078, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the newly created challenge." + "summary": [ + { + "kind": "text", + "text": "ID of the newly created challenge." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 981, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L981" } ], "type": { @@ -11321,19 +13482,25 @@ } }, { - "id": 1074, + "id": 1079, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor Type which generated the challenge" + "summary": [ + { + "kind": "text", + "text": "Factor Type which generated the challenge" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 984, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L984" } ], "type": { @@ -11354,22 +13521,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1075, 1073, 1074] + "children": [1080, 1078, 1079] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 979, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ] } } }, { - "id": 1076, + "id": 1081, "name": "error", "kind": 1024, "kindString": "Property", @@ -11378,7 +13545,8 @@ { "fileName": "src/lib/types.ts", "line": 989, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L989" } ], "type": { @@ -11390,15 +13558,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1071, 1076] + "children": [1076, 1081] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 978, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L978" } ] } @@ -11406,14 +13574,14 @@ { "type": "reflection", "declaration": { - "id": 1077, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1078, + "id": 1083, "name": "data", "kind": 1024, "kindString": "Property", @@ -11422,7 +13590,8 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { @@ -11431,7 +13600,7 @@ } }, { - "id": 1079, + "id": 1084, "name": "error", "kind": 1024, "kindString": "Property", @@ -11440,12 +13609,13 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11453,15 +13623,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1078, 1079] + "children": [1083, 1084] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 991, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ] } @@ -11470,7 +13640,7 @@ } }, { - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -11479,7 +13649,8 @@ { "fileName": "src/lib/types.ts", "line": 1286, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1286" } ], "type": { @@ -11488,14 +13659,14 @@ { "type": "reflection", "declaration": { - "id": 1213, + "id": 1218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1214, + "id": 1219, "name": "data", "kind": 1024, "kindString": "Property", @@ -11504,20 +13675,21 @@ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ], "type": { "type": "reflection", "declaration": { - "id": 1215, + "id": 1220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1218, + "id": 1223, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -11525,13 +13697,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1296, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1296" } ], "type": { @@ -11540,19 +13718,25 @@ } }, { - "id": 1216, + "id": 1221, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1290, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1290" } ], "type": { @@ -11561,19 +13745,25 @@ } }, { - "id": 1219, + "id": 1224, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + "summary": [ + { + "kind": "text", + "text": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1299, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1299" } ], "type": { @@ -11582,19 +13772,25 @@ } }, { - "id": 1217, + "id": 1222, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1293, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1293" } ], "type": { @@ -11606,22 +13802,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1218, 1216, 1219, 1217] + "children": [1223, 1221, 1224, 1222] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ] } } }, { - "id": 1220, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -11630,7 +13826,8 @@ { "fileName": "src/lib/types.ts", "line": 1301, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1301" } ], "type": { @@ -11642,15 +13839,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1214, 1220] + "children": [1219, 1225] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1287" } ] } @@ -11658,14 +13855,14 @@ { "type": "reflection", "declaration": { - "id": 1221, + "id": 1226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1222, + "id": 1227, "name": "data", "kind": 1024, "kindString": "Property", @@ -11674,7 +13871,8 @@ { "fileName": "src/lib/types.ts", "line": 1304, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1304" } ], "type": { @@ -11683,7 +13881,7 @@ } }, { - "id": 1223, + "id": 1228, "name": "error", "kind": 1024, "kindString": "Property", @@ -11692,12 +13890,13 @@ { "fileName": "src/lib/types.ts", "line": 1305, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1305" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11705,15 +13904,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1222, 1223] + "children": [1227, 1228] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1303, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1303" } ] } @@ -11722,7 +13921,7 @@ } }, { - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -11731,7 +13930,8 @@ { "fileName": "src/lib/types.ts", "line": 965, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L965" } ], "type": { @@ -11739,19 +13939,19 @@ "types": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" }, { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ] } }, { - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -11760,7 +13960,8 @@ { "fileName": "src/lib/types.ts", "line": 1251, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1251" } ], "type": { @@ -11769,14 +13970,14 @@ { "type": "reflection", "declaration": { - "id": 1197, + "id": 1202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1198, + "id": 1203, "name": "data", "kind": 1024, "kindString": "Property", @@ -11785,20 +13986,21 @@ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ], "type": { "type": "reflection", "declaration": { - "id": 1199, + "id": 1204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1207, + "id": 1212, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -11806,13 +14008,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1277, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1277" } ], "type": { @@ -11821,19 +14029,25 @@ } }, { - "id": 1200, + "id": 1205, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1255, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1255" } ], "type": { @@ -11842,44 +14056,64 @@ } }, { - "id": 1202, + "id": 1207, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "TOTP enrollment information." + "summary": [ + { + "kind": "text", + "text": "TOTP enrollment information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ], "type": { "type": "reflection", "declaration": { - "id": 1203, + "id": 1208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1204, + "id": 1209, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending " + }, + { + "kind": "code", + "text": "`data:image/svg+xml;utf-8,`" + }, + { + "kind": "text", + "text": " to\nthe value. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1265, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1265" } ], "type": { @@ -11888,19 +14122,25 @@ } }, { - "id": 1205, + "id": 1210, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1270, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1270" } ], "type": { @@ -11909,19 +14149,25 @@ } }, { - "id": 1206, + "id": 1211, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + "summary": [ + { + "kind": "text", + "text": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1274, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1274" } ], "type": { @@ -11933,34 +14179,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1204, 1205, 1206] + "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ] } } }, { - "id": 1201, + "id": 1206, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1258, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1258" } ], "type": { @@ -11972,22 +14224,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1207, 1200, 1202, 1201] + "children": [1212, 1205, 1207, 1206] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ] } } }, { - "id": 1208, + "id": 1213, "name": "error", "kind": 1024, "kindString": "Property", @@ -11996,7 +14248,8 @@ { "fileName": "src/lib/types.ts", "line": 1279, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1279" } ], "type": { @@ -12008,15 +14261,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1198, 1208] + "children": [1203, 1213] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1252, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1252" } ] } @@ -12024,14 +14277,14 @@ { "type": "reflection", "declaration": { - "id": 1209, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1210, + "id": 1215, "name": "data", "kind": 1024, "kindString": "Property", @@ -12040,7 +14293,8 @@ { "fileName": "src/lib/types.ts", "line": 1282, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1282" } ], "type": { @@ -12049,7 +14303,7 @@ } }, { - "id": 1211, + "id": 1216, "name": "error", "kind": 1024, "kindString": "Property", @@ -12058,12 +14312,13 @@ { "fileName": "src/lib/types.ts", "line": 1283, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1283" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -12071,15 +14326,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1210, 1211] + "children": [1215, 1216] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1281, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1281" } ] } @@ -12088,7 +14343,7 @@ } }, { - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -12097,7 +14352,8 @@ { "fileName": "src/lib/types.ts", "line": 1010, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1010" } ], "type": { @@ -12106,14 +14362,14 @@ { "type": "reflection", "declaration": { - "id": 1093, + "id": 1098, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1094, + "id": 1099, "name": "data", "kind": 1024, "kindString": "Property", @@ -12122,32 +14378,39 @@ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ], "type": { "type": "reflection", "declaration": { - "id": 1095, + "id": 1100, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1098, + "id": 1103, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + "summary": [ + { + "kind": "text", + "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1029, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1029" } ], "type": { @@ -12160,19 +14423,25 @@ } }, { - "id": 1096, + "id": 1101, "name": "currentLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Current AAL level of the session." + "summary": [ + { + "kind": "text", + "text": "Current AAL level of the session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1014, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1014" } ], "type": { @@ -12180,7 +14449,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -12191,17 +14460,29 @@ } }, { - "id": 1097, + "id": 1102, "name": "nextLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "challenge", + "target": 1116 + } + ] } ] }, @@ -12209,7 +14490,8 @@ { "fileName": "src/lib/types.ts", "line": 1022, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1022" } ], "type": { @@ -12217,7 +14499,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -12231,22 +14513,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1098, 1096, 1097] + "children": [1103, 1101, 1102] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ] } } }, { - "id": 1099, + "id": 1104, "name": "error", "kind": 1024, "kindString": "Property", @@ -12255,7 +14537,8 @@ { "fileName": "src/lib/types.ts", "line": 1031, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1031" } ], "type": { @@ -12267,15 +14550,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1094, 1099] + "children": [1099, 1104] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1011, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1011" } ] } @@ -12283,14 +14566,14 @@ { "type": "reflection", "declaration": { - "id": 1100, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1101, + "id": 1106, "name": "data", "kind": 1024, "kindString": "Property", @@ -12299,7 +14582,8 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { @@ -12308,7 +14592,7 @@ } }, { - "id": 1102, + "id": 1107, "name": "error", "kind": 1024, "kindString": "Property", @@ -12317,12 +14601,13 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -12330,15 +14615,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1101, 1102] + "children": [1106, 1107] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ] } @@ -12347,7 +14632,7 @@ } }, { - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -12356,7 +14641,8 @@ { "fileName": "src/lib/types.ts", "line": 993, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L993" } ], "type": { @@ -12365,14 +14651,14 @@ { "type": "reflection", "declaration": { - "id": 1081, + "id": 1086, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1082, + "id": 1087, "name": "data", "kind": 1024, "kindString": "Property", @@ -12381,32 +14667,39 @@ { "fileName": "src/lib/types.ts", "line": 995, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ], "type": { "type": "reflection", "declaration": { - "id": 1083, + "id": 1088, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1084, + "id": 1089, "name": "all", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All available factors (verified and unverified)." + "summary": [ + { + "kind": "text", + "text": "All available factors (verified and unverified)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 997, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L997" } ], "type": { @@ -12419,19 +14712,33 @@ } }, { - "id": 1086, + "id": 1091, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified Phone factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified Phone factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1002, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1002" } ], "type": { @@ -12444,19 +14751,33 @@ } }, { - "id": 1085, + "id": 1090, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified TOTP factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1000, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1000" } ], "type": { @@ -12472,22 +14793,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1084, 1086, 1085] + "children": [1089, 1091, 1090] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 995, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ] } } }, { - "id": 1087, + "id": 1092, "name": "error", "kind": 1024, "kindString": "Property", @@ -12496,7 +14817,8 @@ { "fileName": "src/lib/types.ts", "line": 1004, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1004" } ], "type": { @@ -12508,15 +14830,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1082, 1087] + "children": [1087, 1092] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 994, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L994" } ] } @@ -12524,14 +14846,14 @@ { "type": "reflection", "declaration": { - "id": 1088, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1089, + "id": 1094, "name": "data", "kind": 1024, "kindString": "Property", @@ -12540,7 +14862,8 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { @@ -12549,7 +14872,7 @@ } }, { - "id": 1090, + "id": 1095, "name": "error", "kind": 1024, "kindString": "Property", @@ -12558,12 +14881,13 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -12571,15 +14895,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1089, 1090] + "children": [1094, 1095] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ] } @@ -12588,7 +14912,7 @@ } }, { - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -12597,7 +14921,8 @@ { "fileName": "src/lib/types.ts", "line": 967, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L967" } ], "type": { @@ -12606,14 +14931,14 @@ { "type": "reflection", "declaration": { - "id": 1061, + "id": 1066, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1067, "name": "data", "kind": 1024, "kindString": "Property", @@ -12622,32 +14947,39 @@ { "fileName": "src/lib/types.ts", "line": 969, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ], "type": { "type": "reflection", "declaration": { - "id": 1063, + "id": 1068, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1064, + "id": 1069, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 971, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L971" } ], "type": { @@ -12659,22 +14991,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1064] + "children": [1069] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 969, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ] } } }, { - "id": 1065, + "id": 1070, "name": "error", "kind": 1024, "kindString": "Property", @@ -12683,7 +15015,8 @@ { "fileName": "src/lib/types.ts", "line": 973, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L973" } ], "type": { @@ -12695,15 +15028,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1062, 1065] + "children": [1067, 1070] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 968, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L968" } ] } @@ -12711,14 +15044,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1071, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1072, "name": "data", "kind": 1024, "kindString": "Property", @@ -12727,7 +15060,8 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { @@ -12736,7 +15070,7 @@ } }, { - "id": 1068, + "id": 1073, "name": "error", "kind": 1024, "kindString": "Property", @@ -12745,12 +15079,13 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -12758,15 +15093,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1067, 1068] + "children": [1072, 1073] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 975, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ] } @@ -12775,7 +15110,7 @@ } }, { - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -12784,7 +15119,8 @@ { "fileName": "src/lib/types.ts", "line": 940, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L940" } ], "type": { @@ -12793,14 +15129,14 @@ { "type": "reflection", "declaration": { - "id": 1047, + "id": 1052, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1048, + "id": 1053, "name": "data", "kind": 1024, "kindString": "Property", @@ -12809,32 +15145,39 @@ { "fileName": "src/lib/types.ts", "line": 942, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ], "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1054, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1055, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "New access token (JWT) after successful verification." + "summary": [ + { + "kind": "text", + "text": "New access token (JWT) after successful verification." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 944, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L944" } ], "type": { @@ -12843,19 +15186,25 @@ } }, { - "id": 1052, + "id": 1057, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Number of seconds in which the access token will expire." + "summary": [ + { + "kind": "text", + "text": "Number of seconds in which the access token will expire." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 950, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L950" } ], "type": { @@ -12864,19 +15213,25 @@ } }, { - "id": 1053, + "id": 1058, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." + "summary": [ + { + "kind": "text", + "text": "Refresh token you can use to obtain new access tokens when expired." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 953, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L953" } ], "type": { @@ -12885,19 +15240,33 @@ } }, { - "id": 1051, + "id": 1056, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of token, typically `Bearer`." + "summary": [ + { + "kind": "text", + "text": "Type of token, typically " + }, + { + "kind": "code", + "text": "`Bearer`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 947, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L947" } ], "type": { @@ -12906,19 +15275,25 @@ } }, { - "id": 1054, + "id": 1059, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Updated user profile." + "summary": [ + { + "kind": "text", + "text": "Updated user profile." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 956, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L956" } ], "type": { @@ -12931,22 +15306,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1050, 1052, 1053, 1051, 1054] + "children": [1055, 1057, 1058, 1056, 1059] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 942, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ] } } }, { - "id": 1055, + "id": 1060, "name": "error", "kind": 1024, "kindString": "Property", @@ -12955,7 +15330,8 @@ { "fileName": "src/lib/types.ts", "line": 958, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L958" } ], "type": { @@ -12967,15 +15343,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1048, 1055] + "children": [1053, 1060] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 941, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L941" } ] } @@ -12983,14 +15359,14 @@ { "type": "reflection", "declaration": { - "id": 1056, + "id": 1061, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1062, "name": "data", "kind": 1024, "kindString": "Property", @@ -12999,7 +15375,8 @@ { "fileName": "src/lib/types.ts", "line": 961, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L961" } ], "type": { @@ -13008,7 +15385,7 @@ } }, { - "id": 1058, + "id": 1063, "name": "error", "kind": 1024, "kindString": "Property", @@ -13017,12 +15394,13 @@ { "fileName": "src/lib/types.ts", "line": 962, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L962" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -13030,15 +15408,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1057, 1058] + "children": [1062, 1063] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 960, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L960" } ] } @@ -13053,14 +15431,24 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthResponse}\n" + "summary": [ + { + "kind": "text", + "text": "AuthOtpResponse is returned when OTP is used.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "AuthResponse" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 146, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L146" } ], "type": { @@ -13085,7 +15473,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -13109,7 +15498,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -13136,7 +15526,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -13154,7 +15545,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -13166,7 +15558,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [645, 644, 643] } ], @@ -13174,7 +15565,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ] } @@ -13190,7 +15582,8 @@ { "fileName": "src/lib/types.ts", "line": 149, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L149" } ], "type": { @@ -13202,7 +15595,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [641, 646] } ], @@ -13210,7 +15602,8 @@ { "fileName": "src/lib/types.ts", "line": 147, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L147" } ] } @@ -13234,7 +15627,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -13258,7 +15652,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -13285,7 +15680,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -13303,7 +15699,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -13315,7 +15712,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [652, 651, 650] } ], @@ -13323,7 +15719,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ] } @@ -13339,12 +15736,13 @@ { "fileName": "src/lib/types.ts", "line": 153, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L153" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -13352,7 +15750,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [648, 653] } ], @@ -13360,7 +15757,8 @@ { "fileName": "src/lib/types.ts", "line": 151, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L151" } ] } @@ -13378,7 +15776,8 @@ { "fileName": "src/lib/types.ts", "line": 108, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L108" } ], "type": { @@ -13403,7 +15802,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ], "type": { @@ -13425,7 +15825,8 @@ { "fileName": "src/lib/types.ts", "line": 112, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L112" } ], "type": { @@ -13453,7 +15854,8 @@ { "fileName": "src/lib/types.ts", "line": 111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L111" } ], "type": { @@ -13475,7 +15877,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [617, 616] } ], @@ -13483,7 +15884,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ] } @@ -13499,7 +15901,8 @@ { "fileName": "src/lib/types.ts", "line": 114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L114" } ], "type": { @@ -13511,7 +15914,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [614, 618] } ], @@ -13519,7 +15921,8 @@ { "fileName": "src/lib/types.ts", "line": 109, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L109" } ] } @@ -13543,7 +15946,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ], "type": { @@ -13565,7 +15969,8 @@ { "fileName": "src/lib/types.ts", "line": 119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L119" } ], "type": { @@ -13583,7 +15988,8 @@ { "fileName": "src/lib/types.ts", "line": 118, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L118" } ], "type": { @@ -13595,7 +16001,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [623, 622] } ], @@ -13603,7 +16008,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ] } @@ -13619,12 +16025,13 @@ { "fileName": "src/lib/types.ts", "line": 121, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L121" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -13632,7 +16039,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [620, 624] } ], @@ -13640,7 +16046,8 @@ { "fileName": "src/lib/types.ts", "line": 116, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L116" } ] } @@ -13658,7 +16065,8 @@ { "fileName": "src/lib/types.ts", "line": 124, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L124" } ], "type": { @@ -13683,7 +16091,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ], "type": { @@ -13705,7 +16114,8 @@ { "fileName": "src/lib/types.ts", "line": 128, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L128" } ], "type": { @@ -13733,7 +16143,8 @@ { "fileName": "src/lib/types.ts", "line": 127, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L127" } ], "type": { @@ -13763,7 +16174,8 @@ { "fileName": "src/lib/types.ts", "line": 129, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L129" } ], "type": { @@ -13785,7 +16197,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [630, 629, 631] } ], @@ -13793,7 +16204,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ] } @@ -13809,7 +16221,8 @@ { "fileName": "src/lib/types.ts", "line": 131, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L131" } ], "type": { @@ -13821,7 +16234,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [627, 632] } ], @@ -13829,7 +16241,8 @@ { "fileName": "src/lib/types.ts", "line": 125, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L125" } ] } @@ -13853,7 +16266,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ], "type": { @@ -13875,7 +16289,8 @@ { "fileName": "src/lib/types.ts", "line": 136, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L136" } ], "type": { @@ -13893,7 +16308,8 @@ { "fileName": "src/lib/types.ts", "line": 135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L135" } ], "type": { @@ -13905,7 +16321,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [637, 636] } ], @@ -13913,7 +16328,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ] } @@ -13929,12 +16345,13 @@ { "fileName": "src/lib/types.ts", "line": 138, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L138" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -13942,7 +16359,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [634, 638] } ], @@ -13950,7 +16366,8 @@ { "fileName": "src/lib/types.ts", "line": 133, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L133" } ] } @@ -13968,7 +16385,8 @@ { "fileName": "src/lib/types.ts", "line": 156, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L156" } ], "type": { @@ -13993,7 +16411,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ], "type": { @@ -14015,7 +16434,8 @@ { "fileName": "src/lib/types.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L160" } ], "type": { @@ -14034,7 +16454,8 @@ { "fileName": "src/lib/types.ts", "line": 159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L159" } ], "type": { @@ -14047,7 +16468,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [659, 658] } ], @@ -14055,7 +16475,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ] } @@ -14071,7 +16492,8 @@ { "fileName": "src/lib/types.ts", "line": 162, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L162" } ], "type": { @@ -14083,7 +16505,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [656, 660] } ], @@ -14091,7 +16512,8 @@ { "fileName": "src/lib/types.ts", "line": 157, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L157" } ] } @@ -14115,7 +16537,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ], "type": { @@ -14137,7 +16560,8 @@ { "fileName": "src/lib/types.ts", "line": 167, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L167" } ], "type": { @@ -14155,7 +16579,8 @@ { "fileName": "src/lib/types.ts", "line": 166, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L166" } ], "type": { @@ -14167,7 +16592,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [665, 664] } ], @@ -14175,7 +16599,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ] } @@ -14191,12 +16616,13 @@ { "fileName": "src/lib/types.ts", "line": 169, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L169" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -14204,7 +16630,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [662, 666] } ], @@ -14212,7 +16637,8 @@ { "fileName": "src/lib/types.ts", "line": 164, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L164" } ] } @@ -14230,7 +16656,8 @@ { "fileName": "src/lib/types.ts", "line": 172, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L172" } ], "type": { @@ -14255,7 +16682,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ], "type": { @@ -14277,7 +16705,8 @@ { "fileName": "src/lib/types.ts", "line": 176, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L176" } ], "type": { @@ -14296,7 +16725,8 @@ { "fileName": "src/lib/types.ts", "line": 175, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L175" } ], "type": { @@ -14317,7 +16747,8 @@ { "fileName": "src/lib/types.ts", "line": 177, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L177" } ], "type": { @@ -14330,7 +16761,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [672, 671, 673] } ], @@ -14338,7 +16768,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ] } @@ -14354,7 +16785,8 @@ { "fileName": "src/lib/types.ts", "line": 179, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L179" } ], "type": { @@ -14366,7 +16798,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [669, 674] } ], @@ -14374,7 +16805,8 @@ { "fileName": "src/lib/types.ts", "line": 173, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L173" } ] } @@ -14398,7 +16830,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ], "type": { @@ -14420,7 +16853,8 @@ { "fileName": "src/lib/types.ts", "line": 184, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L184" } ], "type": { @@ -14438,7 +16872,8 @@ { "fileName": "src/lib/types.ts", "line": 183, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L183" } ], "type": { @@ -14458,7 +16893,8 @@ { "fileName": "src/lib/types.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L185" } ], "type": { @@ -14470,7 +16906,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [679, 678, 680] } ], @@ -14478,7 +16913,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ] } @@ -14494,12 +16930,13 @@ { "fileName": "src/lib/types.ts", "line": 187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L187" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -14507,7 +16944,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [676, 681] } ], @@ -14515,7 +16951,8 @@ { "fileName": "src/lib/types.ts", "line": 181, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L181" } ] } @@ -14524,7 +16961,7 @@ } }, { - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -14533,7 +16970,8 @@ { "fileName": "src/lib/types.ts", "line": 1008, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1008" } ], "type": { @@ -14551,7 +16989,7 @@ } }, { - "id": 1165, + "id": 1170, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -14560,7 +16998,8 @@ { "fileName": "src/lib/types.ts", "line": 1196, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1196" } ], "type": { @@ -14569,14 +17008,14 @@ { "type": "reflection", "declaration": { - "id": 1166, + "id": 1171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1168, + "id": 1173, "name": "error", "kind": 1024, "kindString": "Property", @@ -14585,7 +17024,8 @@ { "fileName": "src/lib/types.ts", "line": 1199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1199" } ], "type": { @@ -14594,7 +17034,7 @@ } }, { - "id": 1167, + "id": 1172, "name": "session", "kind": 1024, "kindString": "Property", @@ -14603,7 +17043,8 @@ { "fileName": "src/lib/types.ts", "line": 1198, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1198" } ], "type": { @@ -14616,15 +17057,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1168, 1167] + "children": [1173, 1172] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1197, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1197" } ] } @@ -14632,14 +17073,14 @@ { "type": "reflection", "declaration": { - "id": 1169, + "id": 1174, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1171, + "id": 1176, "name": "error", "kind": 1024, "kindString": "Property", @@ -14648,17 +17089,18 @@ { "fileName": "src/lib/types.ts", "line": 1203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } }, { - "id": 1170, + "id": 1175, "name": "session", "kind": 1024, "kindString": "Property", @@ -14667,7 +17109,8 @@ { "fileName": "src/lib/types.ts", "line": 1202, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1202" } ], "type": { @@ -14679,15 +17122,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1171, 1170] + "children": [1176, 1175] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1201, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1201" } ] } @@ -14696,7 +17139,7 @@ } }, { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -14705,7 +17148,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -14739,7 +17183,7 @@ } }, { - "id": 914, + "id": 919, "name": "EthereumWallet", "kind": 4194304, "kindString": "Type alias", @@ -14748,7 +17192,8 @@ { "fileName": "src/lib/types.ts", "line": 678, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L678" } ], "type": { @@ -14757,7 +17202,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -14766,7 +17211,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -14775,14 +17221,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -14791,7 +17237,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -14800,7 +17247,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -14811,20 +17258,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14832,13 +17280,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -14847,7 +17301,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -14858,7 +17312,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -14893,18 +17348,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -14912,13 +17367,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -14930,22 +17391,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -14953,13 +17414,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -14968,7 +17435,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -14976,18 +17443,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -14995,15 +17476,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -15011,14 +17492,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -15027,7 +17508,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -15036,19 +17518,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -15057,7 +17569,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -15068,20 +17580,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15089,13 +17602,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -15107,34 +17626,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -15146,15 +17671,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -15163,7 +17688,7 @@ } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15172,32 +17697,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -15206,19 +17738,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -15227,7 +17765,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -15238,7 +17776,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -15246,7 +17785,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15254,13 +17793,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -15269,7 +17808,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -15290,22 +17830,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15314,32 +17854,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -15348,7 +17895,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -15359,7 +17906,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -15367,7 +17915,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15384,13 +17932,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -15399,7 +17947,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -15420,22 +17969,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15444,7 +17993,8 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { @@ -15452,66 +18002,78 @@ "types": [ { "type": "reference", - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams" }, { "type": "reference", - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams" }, { "type": "reference", - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams" }, { "type": "reference", - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams" } ] } }, { - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "The properties related to the email link generated" + "summary": [ + { + "kind": "text", + "text": "The properties related to the email link generated" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ], "type": { "type": "reflection", "declaration": { - "id": 1022, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1023, + "id": 1028, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + "summary": [ + { + "kind": "text", + "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 884, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L884" } ], "type": { @@ -15520,19 +18082,25 @@ } }, { - "id": 1024, + "id": 1029, "name": "email_otp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + "summary": [ + { + "kind": "text", + "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 889, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L889" } ], "type": { @@ -15541,19 +18109,25 @@ } }, { - "id": 1025, + "id": 1030, "name": "hashed_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The hashed token appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The hashed token appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 893, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L893" } ], "type": { @@ -15562,19 +18136,25 @@ } }, { - "id": 1026, + "id": 1031, "name": "redirect_to", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The URL appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The URL appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 895, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L895" } ], "type": { @@ -15583,24 +18163,30 @@ } }, { - "id": 1027, + "id": 1032, "name": "verification_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The verification type that the email link is associated to." + "summary": [ + { + "kind": "text", + "text": "The verification type that the email link is associated to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 897, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L897" } ], "type": { "type": "reference", - "id": 1028, + "id": 1033, "name": "GenerateLinkType" } } @@ -15608,22 +18194,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1023, 1024, 1025, 1026, 1027] + "children": [1028, 1029, 1030, 1031, 1032] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ] } } }, { - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -15632,7 +18218,8 @@ { "fileName": "src/lib/types.ts", "line": 862, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L862" } ], "type": { @@ -15641,14 +18228,14 @@ { "type": "reflection", "declaration": { - "id": 1009, + "id": 1014, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1010, + "id": 1015, "name": "data", "kind": 1024, "kindString": "Property", @@ -15657,20 +18244,21 @@ { "fileName": "src/lib/types.ts", "line": 864, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ], "type": { "type": "reflection", "declaration": { - "id": 1011, + "id": 1016, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1012, + "id": 1017, "name": "properties", "kind": 1024, "kindString": "Property", @@ -15679,17 +18267,18 @@ { "fileName": "src/lib/types.ts", "line": 865, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L865" } ], "type": { "type": "reference", - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties" } }, { - "id": 1013, + "id": 1018, "name": "user", "kind": 1024, "kindString": "Property", @@ -15698,7 +18287,8 @@ { "fileName": "src/lib/types.ts", "line": 866, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L866" } ], "type": { @@ -15711,22 +18301,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1012, 1013] + "children": [1017, 1018] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 864, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ] } } }, { - "id": 1014, + "id": 1019, "name": "error", "kind": 1024, "kindString": "Property", @@ -15735,7 +18325,8 @@ { "fileName": "src/lib/types.ts", "line": 868, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L868" } ], "type": { @@ -15747,15 +18338,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1010, 1014] + "children": [1015, 1019] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 863, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L863" } ] } @@ -15763,14 +18354,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1021, "name": "data", "kind": 1024, "kindString": "Property", @@ -15779,20 +18370,21 @@ { "fileName": "src/lib/types.ts", "line": 871, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ], "type": { "type": "reflection", "declaration": { - "id": 1017, + "id": 1022, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1018, + "id": 1023, "name": "properties", "kind": 1024, "kindString": "Property", @@ -15801,7 +18393,8 @@ { "fileName": "src/lib/types.ts", "line": 872, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L872" } ], "type": { @@ -15810,7 +18403,7 @@ } }, { - "id": 1019, + "id": 1024, "name": "user", "kind": 1024, "kindString": "Property", @@ -15819,7 +18412,8 @@ { "fileName": "src/lib/types.ts", "line": 873, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L873" } ], "type": { @@ -15831,22 +18425,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1018, 1019] + "children": [1023, 1024] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 871, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ] } } }, { - "id": 1020, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -15855,12 +18449,13 @@ { "fileName": "src/lib/types.ts", "line": 875, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L875" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -15868,15 +18463,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1016, 1020] + "children": [1021, 1025] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 870, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L870" } ] } @@ -15885,7 +18480,7 @@ } }, { - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -15894,7 +18489,8 @@ { "fileName": "src/lib/types.ts", "line": 900, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L900" } ], "type": { @@ -15928,7 +18524,7 @@ } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -15937,32 +18533,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -15971,7 +18574,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -15982,7 +18585,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -15990,7 +18594,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -15998,13 +18602,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -16013,7 +18617,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -16025,22 +18630,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -16049,20 +18654,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -16071,7 +18677,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -16080,7 +18687,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -16091,7 +18698,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -16099,7 +18707,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -16116,13 +18724,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -16131,7 +18739,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -16140,7 +18749,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -16149,7 +18758,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -16161,15 +18771,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } @@ -16185,7 +18795,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ], "type": { @@ -16209,7 +18820,8 @@ { "fileName": "src/lib/types.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L70" } ], "type": { @@ -16229,7 +18841,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "type": { @@ -16251,7 +18864,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "signatures": [ @@ -16313,7 +18927,8 @@ { "fileName": "src/lib/types.ts", "line": 68, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L68" } ], "type": { @@ -16333,7 +18948,8 @@ { "fileName": "src/lib/types.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L84" } ], "type": { @@ -16353,12 +18969,13 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L86" } ], "type": { "type": "reference", - "id": 861, + "id": 863, "name": "AuthFlowType" } }, @@ -16371,19 +18988,20 @@ "isOptional": true }, "comment": { - "shortText": "Set to \"true\" if there is a custom authorization header set globally.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Set to \"true\" if there is a custom authorization header set globally." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L99" } ], "type": { @@ -16403,7 +19021,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "type": { @@ -16418,7 +19037,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "indexSignature": { @@ -16456,19 +19076,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L94" } ], "type": { @@ -16489,7 +19110,8 @@ { "fileName": "src/lib/types.ts", "line": 72, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L72" } ], "type": { @@ -16509,12 +19131,13 @@ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L74" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage" } }, @@ -16530,7 +19153,8 @@ { "fileName": "src/lib/types.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L66" } ], "type": { @@ -16550,7 +19174,8 @@ { "fileName": "src/lib/types.ts", "line": 62, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L62" } ], "type": { @@ -16567,25 +19192,65 @@ "isOptional": true }, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, `storage` will only store a JSON object containing the access and refresh token and some adjacent metadata, while `userStorage` will only contain the user object under the key `storageKey + '-user'`.", - "text": "When this option is set and cookie storage is used, `getSession()` and other functions that load a session from the cookie store might not return back a user. It's very important to always use `getUser()` to fetch a user object in those scenarios.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " + }, + { + "kind": "code", + "text": "`storage`" + }, + { + "kind": "text", + "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " + }, + { + "kind": "code", + "text": "`userStorage`" + }, + { + "kind": "text", + "text": " will only contain the user object under the key " + }, + { + "kind": "code", + "text": "`storageKey + '-user'`" + }, + { + "kind": "text", + "text": ".\n\nWhen this option is set and cookie storage is used, " + }, + { + "kind": "code", + "text": "`getSession()`" + }, + { + "kind": "text", + "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " + }, + { + "kind": "code", + "text": "`getUser()`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " to fetch a user object in those scenarios." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L82" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage" } } @@ -16593,7 +19258,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [593, 599, 592, 597, 598, 605, 587, 604, 594, 595, 591, 586, 596] } ], @@ -16601,14 +19265,15 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ] } } }, { - "id": 1162, + "id": 1167, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -16617,20 +19282,21 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { "type": "reflection", "declaration": { - "id": 1163, + "id": 1168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1164, + "id": 1169, "name": "error", "kind": 1024, "kindString": "Property", @@ -16639,7 +19305,8 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { @@ -16647,7 +19314,7 @@ "types": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" }, { @@ -16661,22 +19328,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1164] + "children": [1169] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ] } } }, { - "id": 1224, + "id": 1229, "name": "JwtHeader", "kind": 4194304, "kindString": "Type alias", @@ -16685,20 +19352,21 @@ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ], "type": { "type": "reflection", "declaration": { - "id": 1225, + "id": 1230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1231, "name": "alg", "kind": 1024, "kindString": "Property", @@ -16707,7 +19375,8 @@ { "fileName": "src/lib/types.ts", "line": 1309, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1309" } ], "type": { @@ -16729,7 +19398,7 @@ } }, { - "id": 1227, + "id": 1232, "name": "kid", "kind": 1024, "kindString": "Property", @@ -16738,7 +19407,8 @@ { "fileName": "src/lib/types.ts", "line": 1310, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1310" } ], "type": { @@ -16747,7 +19417,7 @@ } }, { - "id": 1228, + "id": 1233, "name": "typ", "kind": 1024, "kindString": "Property", @@ -16756,7 +19426,8 @@ { "fileName": "src/lib/types.ts", "line": 1311, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1311" } ], "type": { @@ -16768,22 +19439,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1226, 1227, 1228] + "children": [1231, 1232, 1233] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 24 + "character": 24, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ] } } }, { - "id": 1239, + "id": 1244, "name": "JwtPayload", "kind": 4194304, "kindString": "Type alias", @@ -16792,7 +19463,8 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "type": { @@ -16800,13 +19472,13 @@ "types": [ { "type": "reference", - "id": 1229, + "id": 1234, "name": "RequiredClaims" }, { "type": "reflection", "declaration": { - "id": 1240, + "id": 1245, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16815,18 +19487,19 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "indexSignature": { - "id": 1241, + "id": 1246, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1242, + "id": 1247, "name": "key", "kind": 32768, "flags": {}, @@ -16856,7 +19529,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -16871,7 +19545,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -16882,13 +19557,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -16907,7 +19590,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -16921,7 +19609,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -16935,7 +19636,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -16949,7 +19655,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -16968,9 +19675,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16987,9 +19694,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16997,7 +19704,7 @@ } }, { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17006,32 +19713,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -17040,19 +19754,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -17064,22 +19784,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } } }, { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -17088,20 +19808,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -17109,13 +19830,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -17133,19 +19860,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -17157,22 +19890,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } } }, { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17181,7 +19914,8 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { @@ -17189,19 +19923,19 @@ "types": [ { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams" }, { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams" } ] } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -17210,32 +19944,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -17244,7 +19985,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17252,13 +19993,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -17267,19 +20014,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -17291,22 +20044,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } } }, { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -17315,32 +20068,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -17349,7 +20109,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17357,13 +20117,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -17372,7 +20138,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -17380,13 +20146,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -17398,22 +20170,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17422,32 +20194,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -17459,22 +20238,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } } }, { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17483,32 +20262,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -17517,19 +20303,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -17538,19 +20330,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -17562,22 +20360,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } } }, { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -17586,7 +20384,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -17613,7 +20412,8 @@ { "fileName": "src/lib/types.ts", "line": 190, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L190" } ], "type": { @@ -17638,7 +20438,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ], "type": { @@ -17660,7 +20461,8 @@ { "fileName": "src/lib/types.ts", "line": 193, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L193" } ], "type": { @@ -17679,7 +20481,8 @@ { "fileName": "src/lib/types.ts", "line": 194, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L194" } ], "type": { @@ -17691,7 +20494,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [686, 687] } ], @@ -17699,7 +20501,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ] } @@ -17715,7 +20518,8 @@ { "fileName": "src/lib/types.ts", "line": 196, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L196" } ], "type": { @@ -17727,7 +20531,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [684, 688] } ], @@ -17735,7 +20538,8 @@ { "fileName": "src/lib/types.ts", "line": 191, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L191" } ] } @@ -17759,7 +20563,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ], "type": { @@ -17781,7 +20586,8 @@ { "fileName": "src/lib/types.ts", "line": 200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L200" } ], "type": { @@ -17800,7 +20606,8 @@ { "fileName": "src/lib/types.ts", "line": 201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L201" } ], "type": { @@ -17812,7 +20619,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [692, 693] } ], @@ -17820,7 +20626,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ] } @@ -17836,12 +20643,13 @@ { "fileName": "src/lib/types.ts", "line": 203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -17849,7 +20657,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [690, 694] } ], @@ -17857,7 +20664,8 @@ { "fileName": "src/lib/types.ts", "line": 198, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L198" } ] } @@ -17866,7 +20674,7 @@ } }, { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -17875,20 +20683,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -17896,13 +20705,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -17911,7 +20726,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -17919,13 +20734,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -17937,22 +20758,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } } }, { - "id": 1172, + "id": 1177, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -17961,20 +20782,21 @@ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "type": { "type": "reflection", "declaration": { - "id": 1173, + "id": 1178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1175, + "id": 1180, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -17983,7 +20805,8 @@ { "fileName": "src/lib/types.ts", "line": 1209, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1209" } ], "type": { @@ -17992,7 +20815,7 @@ } }, { - "id": 1174, + "id": 1179, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -18001,7 +20824,8 @@ { "fileName": "src/lib/types.ts", "line": 1208, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1208" } ], "type": { @@ -18019,7 +20843,7 @@ } }, { - "id": 1176, + "id": 1181, "name": "total", "kind": 1024, "kindString": "Property", @@ -18028,7 +20852,8 @@ { "fileName": "src/lib/types.ts", "line": 1210, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1210" } ], "type": { @@ -18040,26 +20865,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1175, 1174, 1176] + "children": [1180, 1179, 1181] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "indexSignature": { - "id": 1177, + "id": 1182, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1178, + "id": 1183, "name": "key", "kind": 32768, "flags": {}, @@ -18084,13 +20909,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -18188,7 +21019,7 @@ } }, { - "id": 1229, + "id": 1234, "name": "RequiredClaims", "kind": 4194304, "kindString": "Type alias", @@ -18197,20 +21028,21 @@ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ], "type": { "type": "reflection", "declaration": { - "id": 1230, + "id": 1235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1237, + "id": 1242, "name": "aal", "kind": 1024, "kindString": "Property", @@ -18219,17 +21051,18 @@ { "fileName": "src/lib/types.ts", "line": 1321, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1321" } ], "type": { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" } }, { - "id": 1233, + "id": 1238, "name": "aud", "kind": 1024, "kindString": "Property", @@ -18238,7 +21071,8 @@ { "fileName": "src/lib/types.ts", "line": 1317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1317" } ], "type": { @@ -18259,7 +21093,7 @@ } }, { - "id": 1234, + "id": 1239, "name": "exp", "kind": 1024, "kindString": "Property", @@ -18268,7 +21102,8 @@ { "fileName": "src/lib/types.ts", "line": 1318, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1318" } ], "type": { @@ -18277,7 +21112,7 @@ } }, { - "id": 1235, + "id": 1240, "name": "iat", "kind": 1024, "kindString": "Property", @@ -18286,7 +21121,8 @@ { "fileName": "src/lib/types.ts", "line": 1319, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1319" } ], "type": { @@ -18295,7 +21131,7 @@ } }, { - "id": 1231, + "id": 1236, "name": "iss", "kind": 1024, "kindString": "Property", @@ -18304,7 +21140,8 @@ { "fileName": "src/lib/types.ts", "line": 1315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1315" } ], "type": { @@ -18313,7 +21150,7 @@ } }, { - "id": 1236, + "id": 1241, "name": "role", "kind": 1024, "kindString": "Property", @@ -18322,7 +21159,8 @@ { "fileName": "src/lib/types.ts", "line": 1320, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1320" } ], "type": { @@ -18331,7 +21169,7 @@ } }, { - "id": 1238, + "id": 1243, "name": "session_id", "kind": 1024, "kindString": "Property", @@ -18340,7 +21178,8 @@ { "fileName": "src/lib/types.ts", "line": 1322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1322" } ], "type": { @@ -18349,7 +21188,7 @@ } }, { - "id": 1232, + "id": 1237, "name": "sub", "kind": 1024, "kindString": "Property", @@ -18358,7 +21197,8 @@ { "fileName": "src/lib/types.ts", "line": 1316, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1316" } ], "type": { @@ -18370,22 +21210,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1237, 1233, 1234, 1235, 1231, 1236, 1238, 1232] + "children": [1242, 1238, 1239, 1240, 1236, 1241, 1243, 1237] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ] } } }, { - "id": 955, + "id": 960, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -18394,7 +21234,8 @@ { "fileName": "src/lib/types.ts", "line": 769, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L769" } ], "type": { @@ -18403,14 +21244,14 @@ { "type": "reflection", "declaration": { - "id": 956, + "id": 961, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 963, "name": "email", "kind": 1024, "kindString": "Property", @@ -18419,7 +21260,8 @@ { "fileName": "src/lib/types.ts", "line": 772, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L772" } ], "type": { @@ -18428,7 +21270,7 @@ } }, { - "id": 959, + "id": 964, "name": "options", "kind": 1024, "kindString": "Property", @@ -18439,20 +21281,21 @@ { "fileName": "src/lib/types.ts", "line": 773, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ], "type": { "type": "reflection", "declaration": { - "id": 960, + "id": 965, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 962, + "id": 967, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18460,13 +21303,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L777" } ], "type": { @@ -18475,7 +21324,7 @@ } }, { - "id": 961, + "id": 966, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -18483,13 +21332,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 775, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L775" } ], "type": { @@ -18501,22 +21356,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [962, 961] + "children": [967, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 773, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ] } } }, { - "id": 957, + "id": 962, "name": "type", "kind": 1024, "kindString": "Property", @@ -18525,7 +21380,8 @@ { "fileName": "src/lib/types.ts", "line": 771, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L771" } ], "type": { @@ -18533,7 +21389,7 @@ "typeArguments": [ { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" }, { @@ -18550,24 +21406,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [958, 959, 957] + "children": [963, 964, 962] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 770, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L770" } ] } @@ -18575,14 +21431,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 966, + "id": 971, "name": "options", "kind": 1024, "kindString": "Property", @@ -18593,20 +21449,21 @@ { "fileName": "src/lib/types.ts", "line": 783, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ], "type": { "type": "reflection", "declaration": { - "id": 967, + "id": 972, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 968, + "id": 973, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18614,13 +21471,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L785" } ], "type": { @@ -18632,22 +21495,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [968] + "children": [973] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 783, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ] } } }, { - "id": 965, + "id": 970, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18656,7 +21519,8 @@ { "fileName": "src/lib/types.ts", "line": 782, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L782" } ], "type": { @@ -18665,7 +21529,7 @@ } }, { - "id": 964, + "id": 969, "name": "type", "kind": 1024, "kindString": "Property", @@ -18674,7 +21538,8 @@ { "fileName": "src/lib/types.ts", "line": 781, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L781" } ], "type": { @@ -18682,7 +21547,7 @@ "typeArguments": [ { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" }, { @@ -18699,24 +21564,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [966, 965, 964] + "children": [971, 970, 969] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 780, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L780" } ] } @@ -18734,7 +21599,8 @@ { "fileName": "src/lib/types.ts", "line": 206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L206" } ], "type": { @@ -18759,7 +21625,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ], "type": { @@ -18778,14 +21645,27 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.", - "text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n" + "summary": [ + { + "kind": "text", + "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " + }, + { + "kind": "code", + "text": "`window.location.href`" + }, + { + "kind": "text", + "text": " to take\nthe user to the authentication flow." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 216, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L216" } ], "type": { @@ -18797,7 +21677,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [699] } ], @@ -18805,7 +21684,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ] } @@ -18821,7 +21701,8 @@ { "fileName": "src/lib/types.ts", "line": 218, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L218" } ], "type": { @@ -18833,7 +21714,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [697, 700] } ], @@ -18841,7 +21721,8 @@ { "fileName": "src/lib/types.ts", "line": 207, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L207" } ] } @@ -18865,7 +21746,8 @@ { "fileName": "src/lib/types.ts", "line": 221, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L221" } ], "type": { @@ -18883,12 +21765,13 @@ { "fileName": "src/lib/types.ts", "line": 222, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -18896,7 +21779,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [702, 703] } ], @@ -18904,7 +21786,8 @@ { "fileName": "src/lib/types.ts", "line": 220, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L220" } ] } @@ -18913,7 +21796,7 @@ } }, { - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -18922,20 +21805,21 @@ { "fileName": "src/lib/types.ts", "line": 490, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ], "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 812, "name": "options", "kind": 1024, "kindString": "Property", @@ -18946,20 +21830,21 @@ { "fileName": "src/lib/types.ts", "line": 491, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ], "type": { "type": "reflection", "declaration": { - "id": 811, + "id": 813, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 813, + "id": 815, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18967,13 +21852,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 499, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L499" } ], "type": { @@ -18982,7 +21873,7 @@ } }, { - "id": 812, + "id": 814, "name": "data", "kind": 1024, "kindString": "Property", @@ -18990,14 +21881,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 497, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L497" } ], "type": { @@ -19009,15 +21921,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [813, 812] + "children": [815, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 491, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ] } @@ -19027,22 +21939,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [810] + "children": [812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 490, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ] } } }, { - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19051,20 +21963,21 @@ { "fileName": "src/lib/types.ts", "line": 617, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ], "type": { "type": "reflection", "declaration": { - "id": 875, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 881, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -19072,13 +21985,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L623" } ], "type": { @@ -19087,7 +22014,7 @@ } }, { - "id": 880, + "id": 882, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -19095,13 +22022,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L625" } ], "type": { @@ -19110,7 +22051,7 @@ } }, { - "id": 881, + "id": 883, "name": "options", "kind": 1024, "kindString": "Property", @@ -19121,20 +22062,21 @@ { "fileName": "src/lib/types.ts", "line": 626, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ], "type": { "type": "reflection", "declaration": { - "id": 882, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 883, + "id": 885, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19142,13 +22084,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 628, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L628" } ], "type": { @@ -19160,34 +22108,96 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [883] + "children": [885] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 626, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ] } } }, { - "id": 876, + "id": 878, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)." + "summary": [ + { + "kind": "text", + "text": "Provider name or OIDC " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " value identifying which provider should be used to verify the provided token. Supported names: " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`apple`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`azure`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`facebook`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`kakao`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`keycloak`" + }, + { + "kind": "text", + "text": " (deprecated)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 619, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ], "type": { @@ -19223,7 +22233,7 @@ { "type": "reflection", "declaration": { - "id": 877, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -19232,7 +22242,8 @@ { "fileName": "src/lib/types.ts", "line": 619, - "character": 76 + "character": 76, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ] } @@ -19243,19 +22254,57 @@ } }, { - "id": 878, + "id": 880, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." + "summary": [ + { + "kind": "text", + "text": "OIDC ID token issued by the specified provider. The " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " which require that you provide an " + }, + { + "kind": "code", + "text": "`access_token`" + }, + { + "kind": "text", + "text": " value to be accepted properly. If the token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim you must supply the nonce used to obtain the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 621, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L621" } ], "type": { @@ -19267,22 +22316,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [879, 880, 881, 876, 878] + "children": [881, 882, 883, 878, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 617, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ] } } }, { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19291,20 +22340,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -19315,20 +22365,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -19336,19 +22387,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -19357,18 +22414,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -19387,7 +22445,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19395,13 +22453,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -19410,7 +22474,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -19418,13 +22482,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -19433,7 +22503,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -19441,13 +22511,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -19459,34 +22535,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -19499,22 +22581,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } } }, { - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19523,7 +22605,8 @@ { "fileName": "src/lib/types.ts", "line": 541, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L541" } ], "type": { @@ -19532,26 +22615,32 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 835, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 544, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L544" } ], "type": { @@ -19560,7 +22649,7 @@ } }, { - "id": 835, + "id": 837, "name": "options", "kind": 1024, "kindString": "Property", @@ -19571,20 +22660,21 @@ { "fileName": "src/lib/types.ts", "line": 547, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ], "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19592,13 +22682,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L549" } ], "type": { @@ -19610,34 +22706,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [837] + "children": [839] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 547, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ] } } }, { - "id": 834, + "id": 836, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 546, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L546" } ], "type": { @@ -19649,15 +22751,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [833, 835, 834] + "children": [835, 837, 836] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 542, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L542" } ] } @@ -19665,14 +22767,14 @@ { "type": "reflection", "declaration": { - "id": 838, + "id": 840, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 843, "name": "options", "kind": 1024, "kindString": "Property", @@ -19683,20 +22785,21 @@ { "fileName": "src/lib/types.ts", "line": 557, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 843, + "id": 845, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19704,13 +22807,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L559" } ], "type": { @@ -19722,34 +22831,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [843] + "children": [845] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 557, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ] } } }, { - "id": 840, + "id": 842, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 556, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L556" } ], "type": { @@ -19758,19 +22873,25 @@ } }, { - "id": 839, + "id": 841, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 554, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L554" } ], "type": { @@ -19782,15 +22903,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [841, 840, 839] + "children": [843, 842, 841] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 552, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L552" } ] } @@ -19799,7 +22920,7 @@ } }, { - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19808,7 +22929,8 @@ { "fileName": "src/lib/types.ts", "line": 563, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L563" } ], "type": { @@ -19817,26 +22939,32 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L566" } ], "type": { @@ -19845,7 +22973,7 @@ } }, { - "id": 847, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -19856,20 +22984,21 @@ { "fileName": "src/lib/types.ts", "line": 567, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ], "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 852, + "id": 854, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19877,13 +23006,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 579, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L579" } ], "type": { @@ -19892,7 +23027,7 @@ } }, { - "id": 851, + "id": 853, "name": "data", "kind": 1024, "kindString": "Property", @@ -19900,14 +23035,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L577" } ], "type": { @@ -19916,7 +23072,7 @@ } }, { - "id": 849, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -19924,13 +23080,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L569" } ], "type": { @@ -19939,7 +23101,7 @@ } }, { - "id": 850, + "id": 852, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -19947,13 +23109,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L571" } ], "type": { @@ -19965,15 +23133,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [852, 851, 849, 850] + "children": [854, 853, 851, 852] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 567, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ] } @@ -19983,15 +23151,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [846, 847] + "children": [848, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 564, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L564" } ] } @@ -19999,14 +23167,14 @@ { "type": "reflection", "declaration": { - "id": 853, + "id": 855, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 855, + "id": 857, "name": "options", "kind": 1024, "kindString": "Property", @@ -20017,20 +23185,21 @@ { "fileName": "src/lib/types.ts", "line": 585, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ], "type": { "type": "reflection", "declaration": { - "id": 856, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 861, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20038,13 +23207,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 595, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L595" } ], "type": { @@ -20053,7 +23228,7 @@ } }, { - "id": 860, + "id": 862, "name": "channel", "kind": 1024, "kindString": "Property", @@ -20061,13 +23236,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 597, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L597" } ], "type": { @@ -20085,7 +23266,7 @@ } }, { - "id": 858, + "id": 860, "name": "data", "kind": 1024, "kindString": "Property", @@ -20093,14 +23274,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 593, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L593" } ], "type": { @@ -20109,7 +23311,7 @@ } }, { - "id": 857, + "id": 859, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -20117,13 +23319,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L587" } ], "type": { @@ -20135,34 +23343,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [859, 860, 858, 857] + "children": [861, 862, 860, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 585, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ] } } }, { - "id": 854, + "id": 856, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 584, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L584" } ], "type": { @@ -20174,15 +23388,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [855, 854] + "children": [857, 856] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 582, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L582" } ] } @@ -20191,7 +23405,7 @@ } }, { - "id": 969, + "id": 974, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -20200,7 +23414,8 @@ { "fileName": "src/lib/types.ts", "line": 789, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L789" } ], "type": { @@ -20209,14 +23424,14 @@ { "type": "reflection", "declaration": { - "id": 970, + "id": 975, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 972, + "id": 977, "name": "options", "kind": 1024, "kindString": "Property", @@ -20227,20 +23442,21 @@ { "fileName": "src/lib/types.ts", "line": 794, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ], "type": { "type": "reflection", "declaration": { - "id": 973, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 975, + "id": 980, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20248,13 +23464,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 798, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L798" } ], "type": { @@ -20263,7 +23485,7 @@ } }, { - "id": 974, + "id": 979, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20271,13 +23493,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L796" } ], "type": { @@ -20289,34 +23517,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [975, 974] + "children": [980, 979] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ] } } }, { - "id": 971, + "id": 976, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." + "summary": [ + { + "kind": "text", + "text": "UUID of the SSO provider to invoke single-sign on to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 792, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L792" } ], "type": { @@ -20328,15 +23562,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [972, 971] + "children": [977, 976] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 790, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L790" } ] } @@ -20344,26 +23578,32 @@ { "type": "reflection", "declaration": { - "id": 976, + "id": 981, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 977, + "id": 982, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." + "summary": [ + { + "kind": "text", + "text": "Domain name of the organization for which to invoke single-sign on." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 803, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L803" } ], "type": { @@ -20372,7 +23612,7 @@ } }, { - "id": 978, + "id": 983, "name": "options", "kind": 1024, "kindString": "Property", @@ -20383,20 +23623,21 @@ { "fileName": "src/lib/types.ts", "line": 805, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ], "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 984, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 981, + "id": 986, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20404,13 +23645,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 809, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L809" } ], "type": { @@ -20419,7 +23666,7 @@ } }, { - "id": 980, + "id": 985, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20427,13 +23674,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L807" } ], "type": { @@ -20445,15 +23698,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [981, 980] + "children": [986, 985] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 805, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ] } @@ -20463,15 +23716,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [977, 978] + "children": [982, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 801, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L801" } ] } @@ -20480,7 +23733,7 @@ } }, { - "id": 1183, + "id": 1188, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -20489,20 +23742,21 @@ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ], "type": { "type": "reflection", "declaration": { - "id": 1184, + "id": 1189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1185, + "id": 1190, "name": "scope", "kind": 1024, "kindString": "Property", @@ -20510,13 +23764,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + "summary": [ + { + "kind": "text", + "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1231, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1231" } ], "type": { @@ -20541,22 +23801,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1185] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ] } } }, { - "id": 1251, + "id": 1256, "name": "SignOutScope", "kind": 4194304, "kindString": "Type alias", @@ -20565,7 +23825,8 @@ { "fileName": "src/lib/types.ts", "line": 1338, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1338" } ], "type": { @@ -20578,14 +23839,14 @@ "type": "query", "queryType": { "type": "reference", - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES" } } } }, { - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20594,7 +23855,8 @@ { "fileName": "src/lib/types.ts", "line": 503, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L503" } ], "type": { @@ -20603,26 +23865,32 @@ { "type": "reflection", "declaration": { - "id": 815, + "id": 817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 818, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 506, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L506" } ], "type": { @@ -20631,7 +23899,7 @@ } }, { - "id": 818, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -20642,20 +23910,21 @@ { "fileName": "src/lib/types.ts", "line": 509, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ], "type": { "type": "reflection", "declaration": { - "id": 819, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 822, + "id": 824, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20663,13 +23932,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 519, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L519" } ], "type": { @@ -20678,7 +23953,7 @@ } }, { - "id": 821, + "id": 823, "name": "data", "kind": 1024, "kindString": "Property", @@ -20686,14 +23961,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 517, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L517" } ], "type": { @@ -20702,7 +23998,7 @@ } }, { - "id": 820, + "id": 822, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -20710,13 +24006,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L511" } ], "type": { @@ -20728,34 +24030,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [822, 821, 820] + "children": [824, 823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 509, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ] } } }, { - "id": 817, + "id": 819, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L508" } ], "type": { @@ -20767,15 +24075,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [816, 818, 817] + "children": [818, 820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 504, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L504" } ] } @@ -20783,14 +24091,14 @@ { "type": "reflection", "declaration": { - "id": 823, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 826, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -20801,20 +24109,21 @@ { "fileName": "src/lib/types.ts", "line": 527, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20822,13 +24131,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L535" } ], "type": { @@ -20837,7 +24152,7 @@ } }, { - "id": 830, + "id": 832, "name": "channel", "kind": 1024, "kindString": "Property", @@ -20845,13 +24160,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 537, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L537" } ], "type": { @@ -20869,7 +24190,7 @@ } }, { - "id": 828, + "id": 830, "name": "data", "kind": 1024, "kindString": "Property", @@ -20877,14 +24198,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L533" } ], "type": { @@ -20896,34 +24238,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [829, 830, 828] + "children": [831, 832, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 527, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ] } } }, { - "id": 825, + "id": 827, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 526, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L526" } ], "type": { @@ -20932,19 +24280,25 @@ } }, { - "id": 824, + "id": 826, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 524, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L524" } ], "type": { @@ -20956,15 +24310,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [826, 825, 824] + "children": [828, 827, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 522, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L522" } ] } @@ -20973,7 +24327,7 @@ } }, { - "id": 884, + "id": 886, "name": "SolanaWallet", "kind": 4194304, "kindString": "Type alias", @@ -20982,20 +24336,21 @@ { "fileName": "src/lib/types.ts", "line": 632, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ], "type": { "type": "reflection", "declaration": { - "id": 885, + "id": 887, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 889, + "id": 892, "name": "publicKey", "kind": 1024, "kindString": "Property", @@ -21006,7 +24361,8 @@ { "fileName": "src/lib/types.ts", "line": 634, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ], "type": { @@ -21015,52 +24371,71 @@ { "type": "reflection", "declaration": { - "id": 890, + "id": 893, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 891, + "id": 894, "name": "toBase58", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 635, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" } ], - "signatures": [ - { - "id": 892, - "name": "toBase58", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 895, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 635, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" + } + ], + "signatures": [ + { + "id": 896, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } - ] + } } ], "groups": [ { - "title": "Methods", - "kind": 2048, - "children": [891] + "title": "Properties", + "children": [894] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 634, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ] } @@ -21073,10 +24448,10 @@ } }, { - "id": 886, + "id": 888, "name": "signIn", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -21084,66 +24459,85 @@ { "fileName": "src/lib/types.ts", "line": 633, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "signatures": [ - { - "id": 887, - "name": "signIn", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 889, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ + "sources": [ { - "id": 888, - "name": "inputs", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "SolanaSignInInput" - } - } + "fileName": "src/lib/types.ts", + "line": 633, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "SolanaSignInOutput" + "signatures": [ + { + "id": 890, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 891, + "name": "inputs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isRest": true }, - { + "type": { "type": "array", "elementType": { "type": "reference", - "name": "SolanaSignInOutput" + "name": "SolanaSignInInput" } } - ] + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "SolanaSignInOutput" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "SolanaSignInOutput" + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + } + ] } - ] + } }, { - "id": 893, + "id": 897, "name": "signMessage", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -21151,95 +24545,118 @@ { "fileName": "src/lib/types.ts", "line": 638, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "signatures": [ - { - "id": 894, - "name": "signMessage", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 898, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ - { - "id": 895, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - }, + "sources": [ { - "id": 896, - "name": "encoding", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/lib/types.ts", + "line": 638, + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 899, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 900, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + }, + { + "id": 901, + "name": "encoding", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "utf8" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Uint8Array", + "qualifiedName": "Uint8Array", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] } - ] - } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [889] - }, - { - "title": "Methods", - "kind": 2048, - "children": [886, 893] + "children": [892, 888, 897] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 632, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ] } } }, { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -21248,7 +24665,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -21257,14 +24675,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -21273,7 +24691,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -21282,7 +24701,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -21293,20 +24712,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21314,13 +24734,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -21329,7 +24755,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -21340,7 +24766,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -21379,18 +24806,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -21398,13 +24825,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -21416,22 +24849,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -21439,13 +24872,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -21454,7 +24893,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -21462,18 +24901,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -21481,15 +24934,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -21497,14 +24950,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -21513,7 +24966,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -21522,19 +24976,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -21543,7 +25027,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -21554,20 +25038,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21575,13 +25060,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -21593,56 +25084,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -21651,7 +25148,7 @@ } }, { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -21660,7 +25157,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -21674,9 +25172,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -21696,9 +25194,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -21706,14 +25204,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -21721,13 +25219,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -21739,15 +25251,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -21765,7 +25277,8 @@ { "fileName": "src/lib/types.ts", "line": 225, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L225" } ], "type": { @@ -21790,7 +25303,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ], "type": { @@ -21812,7 +25326,8 @@ { "fileName": "src/lib/types.ts", "line": 228, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L228" } ], "type": { @@ -21825,7 +25340,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [708] } ], @@ -21833,7 +25347,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ] } @@ -21849,7 +25364,8 @@ { "fileName": "src/lib/types.ts", "line": 230, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L230" } ], "type": { @@ -21861,7 +25377,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [706, 709] } ], @@ -21869,7 +25384,8 @@ { "fileName": "src/lib/types.ts", "line": 226, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L226" } ] } @@ -21893,7 +25409,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ], "type": { @@ -21915,7 +25432,8 @@ { "fileName": "src/lib/types.ts", "line": 234, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L234" } ], "type": { @@ -21927,7 +25445,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [713] } ], @@ -21935,7 +25452,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ] } @@ -21951,12 +25469,13 @@ { "fileName": "src/lib/types.ts", "line": 236, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L236" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -21964,7 +25483,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [711, 714] } ], @@ -21972,7 +25490,8 @@ { "fileName": "src/lib/types.ts", "line": 232, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L232" } ] } @@ -21981,7 +25500,7 @@ } }, { - "id": 933, + "id": 938, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -21990,7 +25509,8 @@ { "fileName": "src/lib/types.ts", "line": 719, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L719" } ], "type": { @@ -21998,17 +25518,17 @@ "types": [ { "type": "reference", - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams" }, { "type": "reference", - "id": 950, + "id": 955, "name": "VerifyTokenHashParams" } ] @@ -22024,7 +25544,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ], "type": { @@ -22046,7 +25567,8 @@ { "fileName": "src/lib/types.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L105" } ], "type": { @@ -22064,7 +25586,8 @@ { "fileName": "src/lib/types.ts", "line": 104, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L104" } ], "type": { @@ -22080,7 +25603,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [611, 610] } ], @@ -22088,7 +25610,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ] } @@ -22104,7 +25627,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ], "type": { @@ -22141,7 +25665,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 80 + "character": 80, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ] } @@ -22152,7 +25677,7 @@ } }, { - "id": 932, + "id": 937, "name": "Web3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -22161,7 +25686,8 @@ { "fileName": "src/lib/types.ts", "line": 717, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L717" } ], "type": { @@ -22169,12 +25695,12 @@ "types": [ { "type": "reference", - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials" }, { "type": "reference", - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials" } ] @@ -22192,7 +25718,8 @@ { "fileName": "src/AuthAdminApi.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthAdminApi.ts#L3" } ], "type": { @@ -22217,7 +25744,8 @@ { "fileName": "src/AuthClient.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthClient.ts#L3" } ], "type": { @@ -22231,7 +25759,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES", "kind": 32, "kindString": "Variable", @@ -22242,7 +25770,8 @@ { "fileName": "src/lib/types.ts", "line": 1337, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1337" } ], "type": { @@ -22277,18 +25806,15 @@ "isConst": true }, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 6, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" } ], "type": { @@ -22307,18 +25833,15 @@ "kindString": "Property", "flags": {}, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L10" } ], "type": { @@ -22331,16 +25854,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [563] } + ], + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 6, + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" + } ] } }, "defaultValue": "..." }, { - "id": 1255, + "id": 1260, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -22349,19 +25879,20 @@ { "fileName": "src/lib/errors.ts", "line": 41, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L41" } ], "signatures": [ { - "id": 1256, + "id": 1261, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1257, + "id": 1262, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22378,7 +25909,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" } } @@ -22386,7 +25917,7 @@ ] }, { - "id": 1252, + "id": 1257, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -22395,19 +25926,20 @@ { "fileName": "src/lib/errors.ts", "line": 26, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L26" } ], "signatures": [ { - "id": 1253, + "id": 1258, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1254, + "id": 1259, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22424,7 +25956,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -22432,7 +25964,7 @@ ] }, { - "id": 1261, + "id": 1266, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -22441,19 +25973,20 @@ { "fileName": "src/lib/errors.ts", "line": 105, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L105" } ], "signatures": [ { - "id": 1262, + "id": 1267, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1263, + "id": 1268, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22470,7 +26003,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" } } @@ -22478,7 +26011,7 @@ ] }, { - "id": 1264, + "id": 1269, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -22487,19 +26020,20 @@ { "fileName": "src/lib/errors.ts", "line": 135, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L135" } ], "signatures": [ { - "id": 1265, + "id": 1270, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1266, + "id": 1271, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22516,7 +26050,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" } } @@ -22524,7 +26058,7 @@ ] }, { - "id": 1258, + "id": 1263, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -22533,19 +26067,20 @@ { "fileName": "src/lib/errors.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L72" } ], "signatures": [ { - "id": 1259, + "id": 1264, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1260, + "id": 1265, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22562,7 +26097,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" } } @@ -22570,7 +26105,7 @@ ] }, { - "id": 1267, + "id": 1272, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -22579,19 +26114,20 @@ { "fileName": "src/lib/errors.ts", "line": 157, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L157" } ], "signatures": [ { - "id": 1268, + "id": 1273, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1269, + "id": 1274, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -22608,7 +26144,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" } } @@ -22625,7 +26161,8 @@ { "fileName": "src/lib/locks.ts", "line": 59, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L59" } ], "signatures": [ @@ -22636,8 +26173,54 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring {@link\nGoTrueClient}.", - "text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClient", + "target": 78 + }, + { + "kind": "text", + "text": ".\n\nYou can turn on debugging by setting the " + }, + { + "kind": "code", + "text": "`supabase.gotrue-js.locks.debug`" + }, + { + "kind": "text", + "text": "\nlocal storage item to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " + }, + { + "kind": "code", + "text": "`request`" + }, + { + "kind": "text", + "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." + } + ] }, "typeParameter": [ { @@ -22656,7 +26239,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -22670,7 +26258,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -22684,7 +26285,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -22694,6 +26300,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 62, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L62" + } + ], "signatures": [ { "id": 555, @@ -22710,9 +26324,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22729,9 +26343,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22746,7 +26360,8 @@ { "fileName": "src/lib/locks.ts", "line": 171, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L171" } ], "signatures": [ @@ -22757,8 +26372,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.", - "text": "Use {@link #navigatorLock} in browser environments.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#navigatorLock", + "target": 0 + }, + { + "kind": "text", + "text": " in browser environments." + } + ] }, "typeParameter": [ { @@ -22777,7 +26406,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -22791,7 +26425,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -22805,7 +26452,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -22815,6 +26467,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 174, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L174" + } + ], "signatures": [ { "id": 571, @@ -22831,9 +26491,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22850,9 +26510,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -22861,45 +26521,41 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [ - 1280, 1270, 1337, 1328, 1413, 1320, 1364, 1391, 1312, 1290, 1401, 1300, 1, 78, 556 + 1285, 1275, 1342, 1333, 1418, 1325, 1369, 1396, 1317, 1295, 1406, 1305, 1, 78, 556 ] }, { "title": "Interfaces", - "kind": 256, "children": [ - 724, 787, 740, 1004, 1152, 1103, 1243, 715, 800, 755, 748, 781, 728, 752, 942, 934, 950 + 724, 787, 740, 1009, 1157, 1108, 1248, 715, 800, 755, 748, 781, 728, 752, 947, 939, 955 ] }, { "title": "Type Aliases", - "kind": 4194304, "children": [ - 574, 573, 861, 1136, 1127, 1149, 1140, 1069, 1212, 1059, 1196, 1092, 1080, 1060, 1046, 639, - 612, 625, 654, 667, 1091, 1165, 954, 914, 915, 998, 988, 1007, 1021, 1008, 1028, 993, 982, - 584, 1162, 1224, 1239, 575, 1042, 1038, 1029, 1191, 1186, 1030, 1033, 953, 682, 1179, 1172, - 572, 1229, 955, 695, 808, 874, 862, 831, 844, 969, 1183, 1251, 814, 884, 897, 1159, 704, - 933, 608, 606, 932 + 574, 573, 863, 1141, 1132, 1154, 1145, 1074, 1217, 1064, 1201, 1097, 1085, 1065, 1051, 639, + 612, 625, 654, 667, 1096, 1170, 959, 919, 920, 1003, 993, 1012, 1026, 1013, 1033, 998, 987, + 584, 1167, 1229, 1244, 575, 1047, 1043, 1034, 1196, 1191, 1035, 1038, 958, 682, 1184, 1177, + 572, 1234, 960, 695, 810, 876, 864, 833, 846, 974, 1188, 1256, 816, 886, 902, 1164, 704, + 938, 608, 606, 937 ] }, { "title": "Variables", - "kind": 32, - "children": [546, 547, 1250, 561] + "children": [546, 547, 1255, 561] }, { "title": "Functions", - "kind": 64, - "children": [1255, 1252, 1261, 1264, 1258, 1267, 548, 564] + "children": [1260, 1257, 1266, 1269, 1263, 1272, 548, 564] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/index.ts#L1" } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index 6ebcce5ff2ae9..04c563f583e30 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1280, + "id": 1285, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1281, + "id": 1286, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -23,19 +23,20 @@ { "fileName": "src/lib/errors.ts", "line": 33, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L33" } ], "signatures": [ { - "id": 1282, + "id": 1287, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1283, + "id": 1288, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +47,7 @@ } }, { - "id": 1284, + "id": 1289, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -57,7 +58,7 @@ } }, { - "id": 1285, + "id": 1290, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -79,36 +80,52 @@ ], "type": { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1287, + "id": 1292, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -128,7 +145,7 @@ { "type": "reflection", "declaration": { - "id": 1288, + "id": 1293, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -145,24 +162,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1286, + "id": 1291, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 31, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L31" } ], "type": { @@ -171,7 +194,7 @@ }, "overwrites": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -179,39 +202,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1281] + "children": [1286] }, { "title": "Properties", - "kind": 1024, - "children": [1287, 1286] + "children": [1292, 1291] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 30, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L30" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] }, { - "id": 1270, + "id": 1275, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1271, + "id": 1276, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -220,19 +242,20 @@ { "fileName": "src/lib/errors.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 1272, + "id": 1277, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1273, + "id": 1278, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -243,7 +266,7 @@ } }, { - "id": 1274, + "id": 1279, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -256,7 +279,7 @@ } }, { - "id": 1275, + "id": 1280, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -271,7 +294,7 @@ ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" }, "overwrites": { @@ -286,19 +309,35 @@ } }, { - "id": 1276, + "id": 1281, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -318,7 +357,7 @@ { "type": "reflection", "declaration": { - "id": 1277, + "id": 1282, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -335,19 +374,25 @@ } }, { - "id": 1278, + "id": 1283, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" } ], "type": { @@ -368,57 +413,56 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1271] + "children": [1276] }, { "title": "Properties", - "kind": 1024, - "children": [1276, 1278] + "children": [1281, 1283] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 4, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L4" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ], "extendedBy": [ { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" }, { "type": "reference", - "id": 1290, + "id": 1295, "name": "AuthUnknownError" }, { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1338, + "id": 1343, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -427,19 +471,20 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "signatures": [ { - "id": 1339, + "id": 1344, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1340, + "id": 1345, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -450,7 +495,7 @@ } }, { - "id": 1341, + "id": 1346, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -465,14 +510,14 @@ { "type": "reflection", "declaration": { - "id": 1342, + "id": 1347, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1344, + "id": 1349, "name": "code", "kind": 1024, "kindString": "Property", @@ -481,7 +526,8 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 57 + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { @@ -490,7 +536,7 @@ } }, { - "id": 1343, + "id": 1348, "name": "error", "kind": 1024, "kindString": "Property", @@ -499,7 +545,8 @@ { "fileName": "src/lib/errors.ts", "line": 90, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ], "type": { @@ -511,8 +558,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1344, 1343] + "children": [1349, 1348] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L90" } ] } @@ -524,36 +578,52 @@ ], "type": { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1361, + "id": 1366, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -573,7 +643,7 @@ { "type": "reflection", "declaration": { - "id": 1362, + "id": 1367, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -590,12 +660,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1345, + "id": 1350, "name": "details", "kind": 1024, "kindString": "Property", @@ -604,7 +674,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -617,14 +688,14 @@ { "type": "reflection", "declaration": { - "id": 1346, + "id": 1351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1348, + "id": 1353, "name": "code", "kind": 1024, "kindString": "Property", @@ -633,7 +704,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -642,7 +714,7 @@ } }, { - "id": 1347, + "id": 1352, "name": "error", "kind": 1024, "kindString": "Property", @@ -651,7 +723,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -663,8 +736,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1348, 1347] + "children": [1353, 1352] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ] } @@ -674,7 +754,7 @@ "defaultValue": "null" }, { - "id": 1359, + "id": 1364, "name": "name", "kind": 1024, "kindString": "Property", @@ -683,7 +763,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -692,24 +773,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1360, + "id": 1365, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -718,12 +805,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } }, { - "id": 1349, + "id": 1354, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -732,12 +819,13 @@ { "fileName": "src/lib/errors.ts", "line": 95, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L95" } ], "signatures": [ { - "id": 1350, + "id": 1355, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -745,14 +833,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1351, + "id": 1356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1355, + "id": 1360, "name": "details", "kind": 1024, "kindString": "Property", @@ -761,7 +849,8 @@ { "fileName": "src/lib/errors.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L100" } ], "type": { @@ -774,14 +863,14 @@ { "type": "reflection", "declaration": { - "id": 1356, + "id": 1361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1358, + "id": 1363, "name": "code", "kind": 1024, "kindString": "Property", @@ -790,7 +879,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -799,7 +889,7 @@ } }, { - "id": 1357, + "id": 1362, "name": "error", "kind": 1024, "kindString": "Property", @@ -808,7 +898,8 @@ { "fileName": "src/lib/errors.ts", "line": 89, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ], "type": { @@ -820,8 +911,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1358, 1357] + "children": [1363, 1362] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L89" } ] } @@ -831,7 +929,7 @@ "defaultValue": "..." }, { - "id": 1353, + "id": 1358, "name": "message", "kind": 1024, "kindString": "Property", @@ -840,7 +938,8 @@ { "fileName": "src/lib/errors.ts", "line": 98, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L98" } ], "type": { @@ -850,7 +949,7 @@ "defaultValue": "..." }, { - "id": 1352, + "id": 1357, "name": "name", "kind": 1024, "kindString": "Property", @@ -859,7 +958,8 @@ { "fileName": "src/lib/errors.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L97" } ], "type": { @@ -869,7 +969,7 @@ "defaultValue": "..." }, { - "id": 1354, + "id": 1359, "name": "status", "kind": 1024, "kindString": "Property", @@ -878,7 +978,8 @@ { "fileName": "src/lib/errors.ts", "line": 99, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L99" } ], "type": { @@ -891,8 +992,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1355, 1353, 1352, 1354] + "children": [1360, 1358, 1357, 1359] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 96, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L96" } ] } @@ -904,44 +1012,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1338] + "children": [1343] }, { "title": "Properties", - "kind": 1024, - "children": [1361, 1345, 1359, 1360] + "children": [1366, 1350, 1364, 1365] }, { "title": "Methods", - "kind": 2048, - "children": [1349] + "children": [1354] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 88, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L88" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1329, + "id": 1334, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -950,19 +1056,20 @@ { "fileName": "src/lib/errors.ts", "line": 83, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L83" } ], "signatures": [ { - "id": 1330, + "id": 1335, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1331, + "id": 1336, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -975,36 +1082,52 @@ ], "type": { "type": "reference", - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1334, + "id": 1339, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1024,7 +1147,7 @@ { "type": "reflection", "declaration": { - "id": 1335, + "id": 1340, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1041,12 +1164,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1332, + "id": 1337, "name": "name", "kind": 1024, "kindString": "Property", @@ -1055,7 +1178,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1064,24 +1188,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1333, + "id": 1338, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1090,7 +1220,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1098,39 +1228,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1329] + "children": [1334] }, { "title": "Properties", - "kind": 1024, - "children": [1334, 1332, 1333] + "children": [1339, 1337, 1338] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 82, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L82" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1414, + "id": 1419, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1139,19 +1268,20 @@ { "fileName": "src/lib/errors.ts", "line": 162, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L162" } ], "signatures": [ { - "id": 1415, + "id": 1420, "name": "new AuthInvalidJwtError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1416, + "id": 1421, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1164,36 +1294,52 @@ ], "type": { "type": "reference", - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1419, + "id": 1424, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1213,7 +1359,7 @@ { "type": "reflection", "declaration": { - "id": 1420, + "id": 1425, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1230,12 +1376,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1417, + "id": 1422, "name": "name", "kind": 1024, "kindString": "Property", @@ -1244,7 +1390,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1253,24 +1400,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1418, + "id": 1423, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1279,7 +1432,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1287,39 +1440,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1414] + "children": [1419] }, { "title": "Properties", - "kind": 1024, - "children": [1419, 1417, 1418] + "children": [1424, 1422, 1423] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 161, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L161" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1321, + "id": 1326, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1328,48 +1480,65 @@ { "fileName": "src/lib/errors.ts", "line": 77, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L77" } ], "signatures": [ { - "id": 1322, + "id": 1327, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1325, + "id": 1330, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1389,7 +1558,7 @@ { "type": "reflection", "declaration": { - "id": 1326, + "id": 1331, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1406,12 +1575,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1323, + "id": 1328, "name": "name", "kind": 1024, "kindString": "Property", @@ -1420,7 +1589,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1429,24 +1599,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1324, + "id": 1329, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1455,7 +1631,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -1463,39 +1639,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1321] + "children": [1326] }, { "title": "Properties", - "kind": 1024, - "children": [1325, 1323, 1324] + "children": [1330, 1328, 1329] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 76, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L76" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1365, + "id": 1370, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1504,19 +1679,20 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "signatures": [ { - "id": 1366, + "id": 1371, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1367, + "id": 1372, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1527,7 +1703,7 @@ } }, { - "id": 1368, + "id": 1373, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1542,14 +1718,14 @@ { "type": "reflection", "declaration": { - "id": 1369, + "id": 1374, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1371, + "id": 1376, "name": "code", "kind": 1024, "kindString": "Property", @@ -1558,7 +1734,8 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 57 + "character": 57, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "type": { @@ -1567,7 +1744,7 @@ } }, { - "id": 1370, + "id": 1375, "name": "error", "kind": 1024, "kindString": "Property", @@ -1576,7 +1753,8 @@ { "fileName": "src/lib/errors.ts", "line": 114, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ], "type": { @@ -1588,8 +1766,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1371, 1370] + "children": [1376, 1375] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 114, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L114" } ] } @@ -1601,36 +1786,52 @@ ], "type": { "type": "reference", - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1388, + "id": 1393, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -1650,7 +1851,7 @@ { "type": "reflection", "declaration": { - "id": 1389, + "id": 1394, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1667,12 +1868,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1372, + "id": 1377, "name": "details", "kind": 1024, "kindString": "Property", @@ -1681,7 +1882,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1694,14 +1896,14 @@ { "type": "reflection", "declaration": { - "id": 1373, + "id": 1378, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1375, + "id": 1380, "name": "code", "kind": 1024, "kindString": "Property", @@ -1710,7 +1912,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1719,7 +1922,7 @@ } }, { - "id": 1374, + "id": 1379, "name": "error", "kind": 1024, "kindString": "Property", @@ -1728,7 +1931,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1740,8 +1944,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1375, 1374] + "children": [1380, 1379] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ] } @@ -1751,7 +1962,7 @@ "defaultValue": "null" }, { - "id": 1386, + "id": 1391, "name": "name", "kind": 1024, "kindString": "Property", @@ -1760,7 +1971,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -1769,24 +1981,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1387, + "id": 1392, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -1795,12 +2013,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } }, { - "id": 1376, + "id": 1381, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1809,12 +2027,13 @@ { "fileName": "src/lib/errors.ts", "line": 119, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L119" } ], "signatures": [ { - "id": 1377, + "id": 1382, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1822,14 +2041,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1378, + "id": 1383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1382, + "id": 1387, "name": "details", "kind": 1024, "kindString": "Property", @@ -1838,7 +2057,8 @@ { "fileName": "src/lib/errors.ts", "line": 124, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L124" } ], "type": { @@ -1851,14 +2071,14 @@ { "type": "reflection", "declaration": { - "id": 1383, + "id": 1388, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1385, + "id": 1390, "name": "code", "kind": 1024, "kindString": "Property", @@ -1867,7 +2087,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 28 + "character": 28, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1876,7 +2097,7 @@ } }, { - "id": 1384, + "id": 1389, "name": "error", "kind": 1024, "kindString": "Property", @@ -1885,7 +2106,8 @@ { "fileName": "src/lib/errors.ts", "line": 112, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ], "type": { @@ -1897,8 +2119,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1385, 1384] + "children": [1390, 1389] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 112, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L112" } ] } @@ -1908,7 +2137,7 @@ "defaultValue": "..." }, { - "id": 1380, + "id": 1385, "name": "message", "kind": 1024, "kindString": "Property", @@ -1917,7 +2146,8 @@ { "fileName": "src/lib/errors.ts", "line": 122, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L122" } ], "type": { @@ -1927,7 +2157,7 @@ "defaultValue": "..." }, { - "id": 1379, + "id": 1384, "name": "name", "kind": 1024, "kindString": "Property", @@ -1936,7 +2166,8 @@ { "fileName": "src/lib/errors.ts", "line": 121, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L121" } ], "type": { @@ -1946,7 +2177,7 @@ "defaultValue": "..." }, { - "id": 1381, + "id": 1386, "name": "status", "kind": 1024, "kindString": "Property", @@ -1955,7 +2186,8 @@ { "fileName": "src/lib/errors.ts", "line": 123, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L123" } ], "type": { @@ -1968,8 +2200,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1382, 1380, 1379, 1381] + "children": [1387, 1385, 1384, 1386] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 120, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L120" } ] } @@ -1981,44 +2220,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1365] + "children": [1370] }, { "title": "Properties", - "kind": 1024, - "children": [1388, 1372, 1386, 1387] + "children": [1393, 1377, 1391, 1392] }, { "title": "Methods", - "kind": 2048, - "children": [1376] + "children": [1381] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 111, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L111" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1392, + "id": 1397, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2027,19 +2264,20 @@ { "fileName": "src/lib/errors.ts", "line": 130, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L130" } ], "signatures": [ { - "id": 1393, + "id": 1398, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1394, + "id": 1399, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2050,7 +2288,7 @@ } }, { - "id": 1395, + "id": 1400, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2063,36 +2301,52 @@ ], "type": { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1398, + "id": 1403, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2112,7 +2366,7 @@ { "type": "reflection", "declaration": { - "id": 1399, + "id": 1404, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2129,12 +2383,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1396, + "id": 1401, "name": "name", "kind": 1024, "kindString": "Property", @@ -2143,7 +2397,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2152,24 +2407,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1397, + "id": 1402, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2178,7 +2439,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2186,39 +2447,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1392] + "children": [1397] }, { "title": "Properties", - "kind": 1024, - "children": [1398, 1396, 1397] + "children": [1403, 1401, 1402] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 129, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L129" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1313, + "id": 1318, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2227,48 +2487,65 @@ { "fileName": "src/lib/errors.ts", "line": 67, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L67" } ], "signatures": [ { - "id": 1314, + "id": 1319, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1317, + "id": 1322, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2288,7 +2565,7 @@ { "type": "reflection", "declaration": { - "id": 1318, + "id": 1323, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2305,12 +2582,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1315, + "id": 1320, "name": "name", "kind": 1024, "kindString": "Property", @@ -2319,7 +2596,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2328,24 +2606,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1316, + "id": 1321, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2354,7 +2638,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2362,39 +2646,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1313] + "children": [1318] }, { "title": "Properties", - "kind": 1024, - "children": [1317, 1315, 1316] + "children": [1322, 1320, 1321] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 66, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L66" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1290, + "id": 1295, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1291, + "id": 1296, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2403,19 +2686,20 @@ { "fileName": "src/lib/errors.ts", "line": 48, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L48" } ], "signatures": [ { - "id": 1292, + "id": 1297, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1293, + "id": 1298, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2426,7 +2710,7 @@ } }, { - "id": 1294, + "id": 1299, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2439,36 +2723,52 @@ ], "type": { "type": "reference", - "id": 1290, + "id": 1295, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1296, + "id": 1301, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2488,7 +2788,7 @@ { "type": "reflection", "declaration": { - "id": 1297, + "id": 1302, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2505,12 +2805,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1295, + "id": 1300, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2519,7 +2819,8 @@ { "fileName": "src/lib/errors.ts", "line": 46, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L46" } ], "type": { @@ -2528,19 +2829,25 @@ } }, { - "id": 1298, + "id": 1303, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L14" } ], "type": { @@ -2558,7 +2865,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -2566,42 +2873,46 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1291] + "children": [1296] }, { "title": "Properties", - "kind": 1024, - "children": [1296, 1295, 1298] + "children": [1301, 1300, 1303] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 45, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L45" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] }, { - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." + "summary": [ + { + "kind": "text", + "text": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate." + } + ] }, "children": [ { - "id": 1402, + "id": 1407, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2610,19 +2921,20 @@ { "fileName": "src/lib/errors.ts", "line": 150, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L150" } ], "signatures": [ { - "id": 1403, + "id": 1408, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1404, + "id": 1409, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2633,7 +2945,7 @@ } }, { - "id": 1405, + "id": 1410, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2644,7 +2956,7 @@ } }, { - "id": 1406, + "id": 1411, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2660,36 +2972,52 @@ ], "type": { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1302, + "id": 1307, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1301, + "id": 1306, "name": "CustomAuthError.constructor" } }, { - "id": 1410, + "id": 1415, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2709,7 +3037,7 @@ { "type": "reflection", "declaration": { - "id": 1411, + "id": 1416, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2726,12 +3054,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1309, + "id": 1314, "name": "CustomAuthError.code" } }, { - "id": 1408, + "id": 1413, "name": "name", "kind": 1024, "kindString": "Property", @@ -2740,7 +3068,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -2749,24 +3078,30 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1312, "name": "CustomAuthError.name" } }, { - "id": 1407, + "id": 1412, "name": "reasons", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Reasons why the password is deemed weak." + "summary": [ + { + "kind": "text", + "text": "Reasons why the password is deemed weak." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 148, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L148" } ], "type": { @@ -2779,19 +3114,25 @@ } }, { - "id": 1409, + "id": 1414, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -2800,7 +3141,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1308, + "id": 1313, "name": "CustomAuthError.status" } } @@ -2808,39 +3149,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1402] + "children": [1407] }, { "title": "Properties", - "kind": 1024, - "children": [1410, 1408, 1407, 1409] + "children": [1415, 1413, 1412, 1414] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 144, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L144" } ], "extendedTypes": [ { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" } ] }, { - "id": 1300, + "id": 1305, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1301, + "id": 1306, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2849,19 +3189,20 @@ { "fileName": "src/lib/errors.ts", "line": 59, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L59" } ], "signatures": [ { - "id": 1302, + "id": 1307, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1303, + "id": 1308, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2872,7 +3213,7 @@ } }, { - "id": 1304, + "id": 1309, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2883,7 +3224,7 @@ } }, { - "id": 1305, + "id": 1310, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2894,7 +3235,7 @@ } }, { - "id": 1306, + "id": 1311, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -2916,36 +3257,52 @@ ], "type": { "type": "reference", - "id": 1300, + "id": 1305, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1272, + "id": 1277, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1271, + "id": 1276, "name": "AuthError.constructor" } }, { - "id": 1309, + "id": 1314, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + "summary": [ + { + "kind": "text", + "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#status", + "target": 0 + }, + { + "kind": "text", + "text": " will also be undefined." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L11" } ], "type": { @@ -2965,7 +3322,7 @@ { "type": "reflection", "declaration": { - "id": 1310, + "id": 1315, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2982,12 +3339,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1276, + "id": 1281, "name": "AuthError.code" } }, { - "id": 1307, + "id": 1312, "name": "name", "kind": 1024, "kindString": "Property", @@ -2996,7 +3353,8 @@ { "fileName": "src/lib/errors.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L56" } ], "type": { @@ -3009,19 +3367,25 @@ } }, { - "id": 1308, + "id": 1313, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "HTTP status code that caused the error." + "summary": [ + { + "kind": "text", + "text": "HTTP status code that caused the error." + } + ] }, "sources": [ { "fileName": "src/lib/errors.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L57" } ], "type": { @@ -3030,7 +3394,7 @@ }, "overwrites": { "type": "reference", - "id": 1278, + "id": 1283, "name": "AuthError.status" } } @@ -3038,68 +3402,67 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [1301] + "children": [1306] }, { "title": "Properties", - "kind": 1024, - "children": [1309, 1307, 1308] + "children": [1314, 1312, 1313] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 55, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L55" } ], "extendedTypes": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1320, + "id": 1325, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1328, + "id": 1333, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1364, + "id": 1369, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" }, { "type": "reference", - "id": 1413, + "id": 1418, "name": "AuthInvalidJwtError" } ] @@ -3121,7 +3484,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L37" } ], "signatures": [ @@ -3159,7 +3523,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 46, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L46" } ], "type": { @@ -3170,6 +3535,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -3189,15 +3561,15 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } @@ -3212,9 +3584,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3223,14 +3595,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3249,7 +3621,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" } ], "type": { @@ -3260,6 +3633,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -3296,7 +3677,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L42" } ], "type": { @@ -3308,9 +3690,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [11, 7, 6] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 41, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L41" + } ] } } @@ -3331,83 +3720,115 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains all MFA administration methods." + "summary": [ + { + "kind": "text", + "text": "Contains all MFA administration methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L29" } ], "type": { "type": "reference", - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ { - "tag": "expermental", - "text": "\n" + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ + { + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -3415,32 +3836,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -3449,19 +3877,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -3473,15 +3907,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } @@ -3495,55 +3929,69 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -3551,32 +3999,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -3588,15 +4043,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } @@ -3610,13 +4065,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3625,15 +4080,15 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] } @@ -3649,7 +4104,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L160" } ], "signatures": [ @@ -3660,7 +4116,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -3689,14 +4158,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -3713,14 +4203,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -3737,13 +4232,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -3764,14 +4265,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -3788,14 +4294,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -3812,14 +4339,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -3840,13 +4372,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -3867,14 +4405,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -3891,13 +4442,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -3918,14 +4475,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -3942,14 +4504,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -3966,14 +4565,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -3985,7 +4605,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788] } ], @@ -3993,7 +4612,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -4010,9 +4630,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -4028,9 +4648,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4045,7 +4665,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 280, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L280" } ], "signatures": [ @@ -4056,7 +4677,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key." + "summary": [ + { + "kind": "text", + "text": "Delete a user. Requires a " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key." + } + ] }, "parameters": [ { @@ -4066,7 +4700,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user id you want to remove." + "summary": [ + { + "kind": "text", + "text": "The user id you want to remove." + } + ] }, "type": { "type": "intrinsic", @@ -4080,7 +4719,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -4098,9 +4750,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4115,7 +4767,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 126, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L126" } ], "signatures": [ @@ -4126,7 +4779,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." + "summary": [ + { + "kind": "text", + "text": "Generates email links and OTPs to be sent via a custom email provider." + } + ] }, "parameters": [ { @@ -4137,10 +4795,10 @@ "flags": {}, "type": { "type": "reference", - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "dereferenced": { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4149,14 +4807,15 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { "type": "union", "types": [ { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4165,20 +4824,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -4187,7 +4847,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -4196,7 +4857,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -4207,7 +4868,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -4215,7 +4877,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -4232,13 +4894,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -4247,7 +4909,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -4256,7 +4919,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -4265,7 +4928,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -4277,22 +4941,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4301,32 +4965,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -4335,7 +5006,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -4346,7 +5017,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -4354,7 +5026,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -4371,13 +5043,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -4386,7 +5058,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -4407,22 +5080,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4431,32 +5104,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -4465,7 +5145,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -4476,7 +5156,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -4484,7 +5165,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -4492,13 +5173,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -4507,7 +5188,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -4519,22 +5201,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4543,32 +5225,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -4577,19 +5266,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -4598,7 +5293,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -4609,7 +5304,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -4617,7 +5313,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -4625,13 +5321,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -4640,7 +5336,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -4661,15 +5358,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } @@ -4686,13 +5383,13 @@ "typeArguments": [ { "type": "reference", - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4707,7 +5404,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 229, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L229" } ], "signatures": [ @@ -4718,7 +5416,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get user by id." + "summary": [ + { + "kind": "text", + "text": "Get user by id." + } + ] }, "parameters": [ { @@ -4728,7 +5431,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -4745,9 +5461,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4762,7 +5478,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 93, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L93" } ], "signatures": [ @@ -4773,7 +5490,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends an invite link to an email address." + "summary": [ + { + "kind": "text", + "text": "Sends an invite link to an email address." + } + ] }, "parameters": [ { @@ -4783,7 +5505,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -4797,7 +5524,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Additional options to be included when inviting.\n" + "summary": [ + { + "kind": "text", + "text": "Additional options to be included when inviting." + } + ] }, "type": { "type": "reflection", @@ -4817,13 +5549,27 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." + "summary": [ + { + "kind": "text", + "text": "A custom data object to store additional metadata about the user. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.user_metadata`" + }, + { + "kind": "text", + "text": " column." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L97" } ], "type": { @@ -4840,13 +5586,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L100" } ], "type": { @@ -4858,9 +5610,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [39, 40] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 95, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L95" + } ] } }, @@ -4876,9 +5635,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4893,7 +5652,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 182, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L182" } ], "signatures": [ @@ -4904,8 +5664,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -4917,14 +5689,35 @@ "isOptional": true }, "comment": { - "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" + "summary": [ + { + "kind": "text", + "text": "An object which supports " + }, + { + "kind": "code", + "text": "`page`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`perPage`" + }, + { + "kind": "text", + "text": " as numbers, to alter the paginated results." + } + ] }, "type": { "type": "reference", - "id": 1179, + "id": 1184, "name": "PageParams", "dereferenced": { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -4933,20 +5726,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -4954,13 +5748,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -4969,7 +5769,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -4977,13 +5777,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -4995,15 +5801,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } @@ -5037,7 +5843,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -5062,7 +5869,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -5080,7 +5888,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -5096,15 +5905,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [54, 53] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, { "type": "reference", - "id": 1172, + "id": 1177, "name": "Pagination" } ] @@ -5120,7 +5936,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -5132,9 +5949,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [51, 55] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, @@ -5157,7 +5981,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -5179,7 +6004,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -5190,9 +6016,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [59] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } @@ -5207,12 +6040,13 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -5220,18 +6054,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [57, 60] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5246,7 +6087,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 62, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L62" } ], "signatures": [ @@ -5257,7 +6099,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes a logged-in session." + "summary": [ + { + "kind": "text", + "text": "Removes a logged-in session." + } + ] }, "parameters": [ { @@ -5267,7 +6114,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A valid, logged-in JWT." + "summary": [ + { + "kind": "text", + "text": "A valid, logged-in JWT." + } + ] }, "type": { "type": "intrinsic", @@ -5281,7 +6133,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The logout sope.\n" + "summary": [ + { + "kind": "text", + "text": "The logout sope." + } + ] }, "type": { "type": "union", @@ -5325,7 +6182,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -5343,7 +6201,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -5355,7 +6214,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -5365,16 +6224,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [32, 33] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5389,7 +6255,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 253, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L253" } ], "signatures": [ @@ -5400,7 +6267,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "summary": [ + { + "kind": "text", + "text": "Updates the user data." + } + ] }, "parameters": [ { @@ -5421,7 +6293,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "reference", @@ -5443,14 +6328,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -5467,14 +6373,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -5491,13 +6402,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -5518,14 +6435,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -5542,14 +6464,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -5566,14 +6509,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -5594,13 +6542,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -5621,14 +6575,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -5645,13 +6612,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -5672,14 +6645,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -5696,14 +6674,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -5720,14 +6735,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -5739,7 +6775,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788] } ], @@ -5747,7 +6782,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -5764,9 +6800,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -5782,9 +6818,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5793,17 +6829,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [2] }, { "title": "Properties", - "kind": 1024, "children": [16] }, { "title": "Methods", - "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], @@ -5811,7 +6844,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L27" } ] }, @@ -5832,7 +6866,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L240" } ], "signatures": [ @@ -5843,7 +6878,12 @@ "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Create a new client for use in the browser." + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] }, "parameters": [ { @@ -5866,7 +6906,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ], "type": { @@ -5890,7 +6931,8 @@ { "fileName": "src/lib/types.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L70" } ], "type": { @@ -5910,7 +6952,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "type": { @@ -5932,7 +6975,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "signatures": [ @@ -5994,7 +7038,8 @@ { "fileName": "src/lib/types.ts", "line": 68, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L68" } ], "type": { @@ -6014,7 +7059,8 @@ { "fileName": "src/lib/types.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L84" } ], "type": { @@ -6034,15 +7080,16 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L86" } ], "type": { "type": "reference", - "id": 861, + "id": 863, "name": "AuthFlowType", "dereferenced": { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -6051,7 +7098,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -6079,19 +7127,20 @@ "isOptional": true }, "comment": { - "shortText": "Set to \"true\" if there is a custom authorization header set globally.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Set to \"true\" if there is a custom authorization header set globally." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L99" } ], "type": { @@ -6111,7 +7160,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "type": { @@ -6126,7 +7176,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "indexSignature": { @@ -6164,19 +7215,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L94" } ], "type": { @@ -6193,7 +7245,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -6208,7 +7261,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -6219,13 +7273,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -6244,7 +7306,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -6258,7 +7325,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -6272,7 +7352,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -6286,7 +7371,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -6305,9 +7391,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6324,9 +7410,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6347,7 +7433,8 @@ { "fileName": "src/lib/types.ts", "line": 72, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L72" } ], "type": { @@ -6367,15 +7454,16 @@ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L74" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -6384,7 +7472,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -6398,9 +7487,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -6420,9 +7509,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -6430,14 +7519,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -6445,13 +7534,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -6463,15 +7566,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -6493,7 +7596,8 @@ { "fileName": "src/lib/types.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L66" } ], "type": { @@ -6513,7 +7617,8 @@ { "fileName": "src/lib/types.ts", "line": 62, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L62" } ], "type": { @@ -6530,28 +7635,68 @@ "isOptional": true }, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, `storage` will only store a JSON object containing the access and refresh token and some adjacent metadata, while `userStorage` will only contain the user object under the key `storageKey + '-user'`.", - "text": "When this option is set and cookie storage is used, `getSession()` and other functions that load a session from the cookie store might not return back a user. It's very important to always use `getUser()` to fetch a user object in those scenarios.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " + }, + { + "kind": "code", + "text": "`storage`" + }, + { + "kind": "text", + "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " + }, + { + "kind": "code", + "text": "`userStorage`" + }, + { + "kind": "text", + "text": " will only contain the user object under the key " + }, { - "tag": "experimental", - "text": "\n" + "kind": "code", + "text": "`storageKey + '-user'`" + }, + { + "kind": "text", + "text": ".\n\nWhen this option is set and cookie storage is used, " + }, + { + "kind": "code", + "text": "`getSession()`" + }, + { + "kind": "text", + "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " + }, + { + "kind": "code", + "text": "`getUser()`" + }, + { + "kind": "text", + "text": " to fetch a user object in those scenarios." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L82" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -6560,7 +7705,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -6574,9 +7720,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -6596,9 +7742,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -6606,14 +7752,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -6621,13 +7767,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -6639,15 +7799,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -6661,7 +7821,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 593, 599, 592, 597, 598, 605, 587, 604, 594, 595, 591, 586, 596 ] @@ -6671,7 +7830,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ] } @@ -6695,13 +7855,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + "summary": [ + { + "kind": "text", + "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 167, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L167" } ], "type": { @@ -6725,7 +7891,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L37" } ], "signatures": [ @@ -6763,7 +7930,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 46, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L46" } ], "type": { @@ -6774,6 +7942,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -6793,15 +7968,15 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } @@ -6816,9 +7991,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -6827,14 +8002,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -6853,7 +8028,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" } ], "type": { @@ -6864,6 +8040,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 43, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L43" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -6900,7 +8084,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L42" } ], "type": { @@ -6912,9 +8097,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [11, 7, 6] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 41, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L41" + } ] } } @@ -6935,83 +8127,115 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains all MFA administration methods." + "summary": [ + { + "kind": "text", + "text": "Contains all MFA administration methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L29" } ], "type": { "type": "reference", - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -7019,32 +8243,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -7053,19 +8284,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -7077,15 +8314,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } @@ -7099,55 +8336,69 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -7155,32 +8406,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -7192,15 +8450,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } @@ -7214,13 +8472,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7229,15 +8487,15 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] } @@ -7253,7 +8511,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L160" } ], "signatures": [ @@ -7264,7 +8523,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -7293,14 +8565,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -7317,14 +8610,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -7341,13 +8639,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -7368,14 +8672,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -7392,14 +8701,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -7416,14 +8746,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -7444,13 +8779,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -7471,14 +8812,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -7495,13 +8849,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -7522,14 +8882,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -7546,14 +8911,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -7570,14 +8972,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -7589,7 +9012,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 ] @@ -7599,7 +9021,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -7616,9 +9039,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -7634,9 +9057,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7651,7 +9074,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 280, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L280" } ], "signatures": [ @@ -7662,7 +9086,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key." + "summary": [ + { + "kind": "text", + "text": "Delete a user. Requires a " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key." + } + ] }, "parameters": [ { @@ -7672,7 +9109,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user id you want to remove." + "summary": [ + { + "kind": "text", + "text": "The user id you want to remove." + } + ] }, "type": { "type": "intrinsic", @@ -7686,7 +9128,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -7704,9 +9159,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -7721,7 +9176,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 126, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L126" } ], "signatures": [ @@ -7732,7 +9188,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." + "summary": [ + { + "kind": "text", + "text": "Generates email links and OTPs to be sent via a custom email provider." + } + ] }, "parameters": [ { @@ -7743,10 +9204,10 @@ "flags": {}, "type": { "type": "reference", - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "dereferenced": { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7755,14 +9216,15 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { "type": "union", "types": [ { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7771,20 +9233,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -7793,7 +9256,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -7802,7 +9266,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -7813,7 +9277,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -7821,7 +9286,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -7838,13 +9303,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -7853,7 +9318,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -7862,7 +9328,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -7871,7 +9337,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -7883,22 +9350,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7907,32 +9374,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -7941,7 +9415,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -7952,7 +9426,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -7960,7 +9435,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -7977,13 +9452,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -7992,7 +9467,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -8013,22 +9489,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -8037,32 +9513,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -8071,7 +9554,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -8082,7 +9565,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -8090,7 +9574,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -8098,13 +9582,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -8113,7 +9597,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -8125,22 +9610,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -8149,32 +9634,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -8183,19 +9675,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -8204,7 +9702,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -8215,7 +9713,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -8223,7 +9722,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -8231,13 +9730,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -8246,7 +9745,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -8267,15 +9767,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } @@ -8292,13 +9792,13 @@ "typeArguments": [ { "type": "reference", - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8313,7 +9813,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 229, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L229" } ], "signatures": [ @@ -8324,7 +9825,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get user by id." + "summary": [ + { + "kind": "text", + "text": "Get user by id." + } + ] }, "parameters": [ { @@ -8334,7 +9840,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "intrinsic", @@ -8351,9 +9870,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8368,7 +9887,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 93, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L93" } ], "signatures": [ @@ -8379,7 +9899,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends an invite link to an email address." + "summary": [ + { + "kind": "text", + "text": "Sends an invite link to an email address." + } + ] }, "parameters": [ { @@ -8389,7 +9914,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -8403,7 +9933,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Additional options to be included when inviting.\n" + "summary": [ + { + "kind": "text", + "text": "Additional options to be included when inviting." + } + ] }, "type": { "type": "reflection", @@ -8423,13 +9958,27 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column." + "summary": [ + { + "kind": "text", + "text": "A custom data object to store additional metadata about the user. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.user_metadata`" + }, + { + "kind": "text", + "text": " column." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 97, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L97" } ], "type": { @@ -8446,13 +9995,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." + } + ] }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", "line": 100, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L100" } ], "type": { @@ -8464,9 +10019,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [39, 40] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 95, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L95" + } ] } }, @@ -8482,9 +10044,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8499,7 +10061,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 182, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L182" } ], "signatures": [ @@ -8510,8 +10073,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." + "summary": [ + { + "kind": "text", + "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "parameters": [ { @@ -8523,14 +10098,35 @@ "isOptional": true }, "comment": { - "shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n" + "summary": [ + { + "kind": "text", + "text": "An object which supports " + }, + { + "kind": "code", + "text": "`page`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`perPage`" + }, + { + "kind": "text", + "text": " as numbers, to alter the paginated results." + } + ] }, "type": { "type": "reference", - "id": 1179, + "id": 1184, "name": "PageParams", "dereferenced": { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -8539,20 +10135,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -8560,13 +10157,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -8575,7 +10178,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -8583,13 +10186,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -8601,15 +10210,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } @@ -8643,7 +10252,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -8668,7 +10278,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -8686,7 +10297,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -8702,15 +10314,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [54, 53] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, { "type": "reference", - "id": 1172, + "id": 1177, "name": "Pagination" } ] @@ -8726,7 +10345,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 185, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" } ], "type": { @@ -8738,9 +10358,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [51, 55] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 185, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L185" + } ] } }, @@ -8763,7 +10390,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -8785,7 +10413,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { @@ -8796,9 +10425,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [59] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } @@ -8813,12 +10449,13 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 186, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -8826,18 +10463,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [57, 60] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L186" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8852,7 +10496,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 62, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L62" } ], "signatures": [ @@ -8863,7 +10508,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes a logged-in session." + "summary": [ + { + "kind": "text", + "text": "Removes a logged-in session." + } + ] }, "parameters": [ { @@ -8873,7 +10523,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A valid, logged-in JWT." + "summary": [ + { + "kind": "text", + "text": "A valid, logged-in JWT." + } + ] }, "type": { "type": "intrinsic", @@ -8887,7 +10542,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The logout sope.\n" + "summary": [ + { + "kind": "text", + "text": "The logout sope." + } + ] }, "type": { "type": "union", @@ -8931,7 +10591,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -8949,7 +10610,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 65, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" } ], "type": { @@ -8961,7 +10623,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -8971,16 +10633,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [32, 33] } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L65" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8995,7 +10664,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 253, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L253" } ], "signatures": [ @@ -9006,7 +10676,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "summary": [ + { + "kind": "text", + "text": "Updates the user data." + } + ] }, "parameters": [ { @@ -9027,7 +10702,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "summary": [ + { + "kind": "text", + "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " key in the browser." + } + ] }, "type": { "type": "reference", @@ -9049,14 +10737,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -9073,14 +10782,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -9097,13 +10811,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -9124,14 +10844,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -9148,14 +10873,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -9172,14 +10918,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -9200,13 +10951,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -9227,14 +10984,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -9251,13 +11021,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -9278,14 +11054,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -9302,14 +11083,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -9326,14 +11144,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -9345,7 +11184,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788 ] @@ -9355,7 +11193,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -9372,9 +11211,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] } @@ -9390,9 +11229,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -9401,17 +11240,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [2] }, { "title": "Properties", - "kind": 1024, "children": [16] }, { "title": "Methods", - "kind": 2048, "children": [44, 68, 41, 61, 34, 47, 27, 64] } ], @@ -9419,7 +11255,8 @@ { "fileName": "src/GoTrueAdminApi.ts", "line": 27, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueAdminApi.ts#L27" } ] } @@ -9432,58 +11269,82 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the MFA methods." + "summary": [ + { + "kind": "text", + "text": "Namespace for the MFA methods." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L171" } ], "type": { "type": "reference", - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "dereferenced": { - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication API." + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication API." + } + ] }, "children": [ { - "id": 1111, + "id": 1116, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1058, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1058" + } + ], "signatures": [ { - "id": 1112, + "id": 1117, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + "summary": [ + { + "kind": "text", + "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + } + ] }, "parameters": [ { - "id": 1113, + "id": 1118, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "dereferenced": { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -9492,20 +11353,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -9513,13 +11375,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -9537,19 +11405,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -9561,15 +11435,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } @@ -9583,46 +11457,59 @@ "typeArguments": [ { "type": "reference", - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1120, + "id": 1125, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1076, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1076" + } + ], "signatures": [ { - "id": 1121, + "id": 1126, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1122, + "id": 1127, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -9631,32 +11518,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -9665,19 +11559,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -9689,15 +11589,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } @@ -9711,47 +11611,87 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1104, + "id": 1109, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1050, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1050" + }, + { + "fileName": "src/lib/types.ts", + "line": 1051, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1051" + }, + { + "fileName": "src/lib/types.ts", + "line": 1052, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1052" + } + ], "signatures": [ { - "id": 1105, + "id": 1110, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + "summary": [ + { + "kind": "text", + "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " + }, + { + "kind": "code", + "text": "`unverified`" + }, + { + "kind": "text", + "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 1106, + "id": 1111, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -9760,32 +11700,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -9794,7 +11741,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9802,13 +11749,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -9817,7 +11770,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -9825,13 +11778,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -9843,15 +11802,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } @@ -9865,34 +11824,34 @@ "typeArguments": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1107, + "id": 1112, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1108, + "id": 1113, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -9901,32 +11860,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -9935,7 +11901,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9943,13 +11909,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -9958,19 +11930,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -9982,15 +11960,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -10004,34 +11982,34 @@ "typeArguments": [ { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1109, + "id": 1114, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1115, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "dereferenced": { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -10040,14 +12018,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -10056,32 +12035,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -10090,7 +12076,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -10098,13 +12084,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -10113,7 +12105,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -10121,13 +12113,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -10139,22 +12137,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -10163,32 +12161,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -10197,7 +12202,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -10205,13 +12210,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -10220,19 +12231,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -10244,15 +12261,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -10269,77 +12286,161 @@ "typeArguments": [ { "type": "reference", - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1125, + "id": 1130, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1101, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1101" + } + ], "signatures": [ { - "id": 1126, + "id": 1131, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + "summary": [ + { + "kind": "text", + "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " + }, + { + "kind": "code", + "text": "`aal1`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1123, + "id": 1128, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1086, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1086" + } + ], "signatures": [ { - "id": 1124, + "id": 1129, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, + "kind": "text", + "text": "Returns the list of MFA factors enabled for this user." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getUser", + "target": 295 + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -10348,46 +12449,75 @@ "typeArguments": [ { "type": "reference", - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1117, + "id": 1122, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1070, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1070" + } + ], "signatures": [ { - "id": 1118, + "id": 1123, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + "summary": [ + { + "kind": "text", + "text": "Unenroll removes a MFA factor.\nA user has to have an " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " authenticator level in order to unenroll a " + }, + { + "kind": "code", + "text": "`verified`" + }, + { + "kind": "text", + "text": " factor." + } + ] }, "parameters": [ { - "id": 1119, + "id": 1124, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "dereferenced": { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -10396,32 +12526,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -10433,15 +12570,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } @@ -10455,46 +12592,59 @@ "typeArguments": [ { "type": "reference", - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1114, + "id": 1119, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1064, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1064" + } + ], "signatures": [ { - "id": 1115, + "id": 1120, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1116, + "id": 1121, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "dereferenced": { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -10503,32 +12653,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -10537,19 +12694,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -10558,19 +12721,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -10582,15 +12751,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } @@ -10604,13 +12773,13 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -10619,15 +12788,15 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1111, 1120, 1104, 1125, 1123, 1117, 1114] + "children": [1116, 1125, 1109, 1130, 1128, 1122, 1119] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1039" } ] } @@ -10643,7 +12812,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 651, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L651" } ], "signatures": [ @@ -10654,7 +12824,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." + } + ] }, "parameters": [ { @@ -10678,9 +12853,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -10695,7 +12870,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3181" } ], "signatures": [ @@ -10706,8 +12882,40 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n`/.well-known/jwks.json` which is often cached, resulting in significantly\nfaster responses. Prefer this method over {@link #getUser} which always\nsends a request to the Auth server for each JWT.", - "text": "If the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to {@link\n#getUser}) to verify the JWT.\n" + "summary": [ + { + "kind": "text", + "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" + }, + { + "kind": "code", + "text": "`/.well-known/jwks.json`" + }, + { + "kind": "text", + "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser", + "target": 0 + }, + { + "kind": "text", + "text": ") to verify the JWT." + } + ] }, "parameters": [ { @@ -10719,7 +12927,22 @@ "isOptional": true }, "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\n can obtain from {@link #getSession}." + "summary": [ + { + "kind": "text", + "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getSession", + "target": 0 + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -10733,7 +12956,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Various additional options that allow you to customize the\n behavior of this method.\n" + "summary": [ + { + "kind": "text", + "text": "Various additional options that allow you to customize the\n behavior of this method." + } + ] }, "type": { "type": "reflection", @@ -10753,13 +12981,35 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` the `exp` claim will not be validated against the current time." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " the " + }, + { + "kind": "code", + "text": "`exp`" + }, + { + "kind": "text", + "text": " claim will not be validated against the current time." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3190, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3190" } ], "type": { @@ -10776,13 +13026,19 @@ "isOptional": true }, "comment": { - "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + "summary": [ + { + "kind": "text", + "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { @@ -10804,14 +13060,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3193, - "character": 15 + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -10820,9 +13077,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [532] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3193, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3193" + } ] } } @@ -10836,10 +13100,16 @@ "isOptional": true }, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Please use options.jwks instead.\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Please use options.jwks instead." + } + ] } ] }, @@ -10847,14 +13117,15 @@ { "fileName": "src/GoTrueClient.ts", "line": 3187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3187" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 1243, + "id": 1248, "name": "JWK" } } @@ -10863,9 +13134,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [529, 530, 528] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3183, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3183" + } ] } }, @@ -10897,7 +13175,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { @@ -10919,12 +13198,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1239, + "id": 1244, "name": "JwtPayload" } }, @@ -10938,12 +13218,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 36 + "character": 36, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", - "id": 1224, + "id": 1229, "name": "JwtHeader" } }, @@ -10957,23 +13238,31 @@ { "fileName": "src/GoTrueClient.ts", "line": 3197, - "character": 55 + "character": 55, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, "children": [536, 537, 538] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3197, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3197" + } ] } } @@ -10988,7 +13277,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3198, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3198" } ], "type": { @@ -11000,9 +13290,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [534, 539] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3196, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3196" + } ] } }, @@ -11025,7 +13322,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { @@ -11043,12 +13341,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 3200, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11056,9 +13355,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [541, 542] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3200, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3200" + } ] } }, @@ -11081,7 +13387,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -11099,7 +13406,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 3201, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" } ], "type": { @@ -11111,18 +13419,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [544, 545] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 3201, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L3201" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -11137,7 +13452,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1355, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1355" } ], "signatures": [ @@ -11148,8 +13464,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session, refreshing it if necessary.", - "text": "The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use {@link #getUser()} instead.\n" + "summary": [ + { + "kind": "text", + "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#getUser()", + "target": 0 + }, + { + "kind": "text", + "text": " instead." + } + ] }, "type": { "type": "reference", @@ -11176,7 +13506,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1448, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" } ], "type": { @@ -11198,7 +13529,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1449, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1449" } ], "type": { @@ -11211,9 +13543,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [237] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1448, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1448" + } ] } } @@ -11228,7 +13567,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1451, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1451" } ], "type": { @@ -11240,9 +13580,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [235, 238] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1447, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1447" + } ] } }, @@ -11265,7 +13612,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1454, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" } ], "type": { @@ -11287,7 +13635,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1455, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1455" } ], "type": { @@ -11299,9 +13648,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [242] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1454, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1454" + } ] } } @@ -11316,12 +13672,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 1457, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1457" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11329,9 +13686,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [240, 243] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1453, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1453" + } ] } }, @@ -11354,7 +13718,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1460, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" } ], "type": { @@ -11376,7 +13741,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1461, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1461" } ], "type": { @@ -11388,9 +13754,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [247] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1460, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1460" + } ] } } @@ -11405,7 +13778,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1463, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1463" } ], "type": { @@ -11417,18 +13791,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [245, 248] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1459, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1459" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -11443,7 +13824,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1599, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1599" } ], "signatures": [ @@ -11454,7 +13836,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + "summary": [ + { + "kind": "text", + "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." + } + ] }, "parameters": [ { @@ -11466,7 +13853,12 @@ "isOptional": true }, "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.\n" + "summary": [ + { + "kind": "text", + "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." + } + ] }, "type": { "type": "intrinsic", @@ -11483,9 +13875,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -11500,7 +13892,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2157, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2157" } ], "signatures": [ @@ -11511,7 +13904,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Gets all the identities linked to a user." + "summary": [ + { + "kind": "text", + "text": "Gets all the identities linked to a user." + } + ] }, "type": { "type": "reference", @@ -11538,7 +13936,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" } ], "type": { @@ -11560,7 +13959,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2160, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2160" } ], "type": { @@ -11576,9 +13976,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [409] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2159, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2159" + } ] } } @@ -11593,7 +14000,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2162, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2162" } ], "type": { @@ -11605,9 +14013,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [407, 410] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2158, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2158" + } ] } }, @@ -11630,7 +14045,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { @@ -11648,12 +14064,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2164, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -11661,18 +14078,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [412, 413] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2164, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2164" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -11687,7 +14111,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 353, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L353" } ], "signatures": [ @@ -11698,20 +14123,25 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + "summary": [ + { + "kind": "text", + "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1162, + "id": 1167, "name": "InitializeResult" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -11726,7 +14156,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2181, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2181" } ], "signatures": [ @@ -11737,7 +14168,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -11748,10 +14184,10 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -11760,20 +14196,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -11784,20 +14221,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -11805,19 +14243,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11826,18 +14270,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -11856,7 +14301,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -11864,13 +14309,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -11879,7 +14330,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -11887,13 +14338,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -11902,7 +14359,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -11910,13 +14367,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -11928,34 +14391,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -11969,13 +14438,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -12078,15 +14553,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } @@ -12104,9 +14579,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -12121,7 +14596,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2055, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2055" } ], "signatures": [ @@ -12132,7 +14608,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Receive a notification every time an auth event happens." + "summary": [ + { + "kind": "text", + "text": "Receive a notification every time an auth event happens." + } + ] }, "parameters": [ { @@ -12142,7 +14623,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\n" + "summary": [ + { + "kind": "text", + "text": "A callback function to be invoked when an auth event happens." + } + ] }, "type": { "type": "reflection", @@ -12152,6 +14638,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2056, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2056" + } + ], "signatures": [ { "id": 380, @@ -12209,9 +14703,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } ] } @@ -12240,7 +14734,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -12262,7 +14757,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2058, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" } ], "type": { @@ -12276,201 +14772,189 @@ "kindString": "Interface", "flags": {}, "children": [ - { - "id": 801, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 802, "name": "callback", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 483, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 803, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 483, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" + } + ], + "signatures": [ { "id": 804, - "name": "event", - "kind": 32768, - "kindString": "Parameter", + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "type": { - "type": "reference", - "id": 574, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 574, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to call every time there is an event. eg: (eventName) => {}" + } + ] + }, + "parameters": [ + { + "id": 805, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 574, + "name": "AuthChangeEvent" + } + }, + { + "id": 806, + "name": "session", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], "type": { "type": "union", "types": [ { "type": "literal", - "value": "INITIAL_SESSION" + "value": null }, { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "id": 573, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } + "type": "reference", + "id": 715, + "name": "Session" } ] } } - } - }, - { - "id": 805, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, + ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 715, - "name": "Session" - } - ] + "type": "intrinsic", + "name": "void" } } - ], - "type": { - "type": "intrinsic", - "name": "void" + ] + } + } + }, + { + "id": 801, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subscriber UUID. This will be set by the client." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L479" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 806, + "id": 807, "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 487, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" } ], - "signatures": [ - { - "id": 807, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" + } + ], + "signatures": [ + { + "id": 809, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Call this to remove the listener." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [801] - }, - { - "title": "Methods", - "kind": 2048, - "children": [802, 806] + "children": [802, 801, 807] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 475, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L475" } ] } @@ -12480,9 +14964,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [386] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2058, + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2058" + } ] } } @@ -12491,9 +14982,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [384] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2057, + "character": 5, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2057" + } ] } } @@ -12510,7 +15008,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1271, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1271" } ], "signatures": [ @@ -12521,7 +15020,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + "summary": [ + { + "kind": "text", + "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." + } + ] }, "type": { "type": "reference", @@ -12532,9 +15036,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -12549,7 +15053,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "signatures": [ @@ -12560,7 +15065,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -12572,7 +15082,12 @@ "isOptional": true }, "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session. If passed in, it must contain a refresh token." + } + ] }, "type": { "type": "reflection", @@ -12593,7 +15108,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1804, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" } ], "type": { @@ -12605,9 +15121,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [329] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1804, + "character": 40, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1804" + } ] } } @@ -12622,9 +15145,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -12639,7 +15162,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1306, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1306" } ], "signatures": [ @@ -12650,7 +15174,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + "summary": [ + { + "kind": "text", + "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." + } + ] }, "parameters": [ { @@ -12661,10 +15190,10 @@ "flags": {}, "type": { "type": "reference", - "id": 955, + "id": 960, "name": "ResendParams", "dereferenced": { - "id": 955, + "id": 960, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -12673,7 +15202,8 @@ { "fileName": "src/lib/types.ts", "line": 769, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L769" } ], "type": { @@ -12682,14 +15212,14 @@ { "type": "reflection", "declaration": { - "id": 956, + "id": 961, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 963, "name": "email", "kind": 1024, "kindString": "Property", @@ -12698,7 +15228,8 @@ { "fileName": "src/lib/types.ts", "line": 772, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L772" } ], "type": { @@ -12707,7 +15238,7 @@ } }, { - "id": 959, + "id": 964, "name": "options", "kind": 1024, "kindString": "Property", @@ -12718,20 +15249,21 @@ { "fileName": "src/lib/types.ts", "line": 773, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ], "type": { "type": "reflection", "declaration": { - "id": 960, + "id": 965, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 962, + "id": 967, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12739,13 +15271,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L777" } ], "type": { @@ -12754,7 +15292,7 @@ } }, { - "id": 961, + "id": 966, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -12762,13 +15300,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 775, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L775" } ], "type": { @@ -12780,22 +15324,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [962, 961] + "children": [967, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 773, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ] } } }, { - "id": 957, + "id": 962, "name": "type", "kind": 1024, "kindString": "Property", @@ -12804,7 +15348,8 @@ { "fileName": "src/lib/types.ts", "line": 771, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L771" } ], "type": { @@ -12812,7 +15357,7 @@ "typeArguments": [ { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" }, { @@ -12829,24 +15374,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [958, 959, 957] + "children": [963, 964, 962] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 770, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L770" } ] } @@ -12854,14 +15399,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 966, + "id": 971, "name": "options", "kind": 1024, "kindString": "Property", @@ -12872,20 +15417,21 @@ { "fileName": "src/lib/types.ts", "line": 783, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ], "type": { "type": "reflection", "declaration": { - "id": 967, + "id": 972, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 968, + "id": 973, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12893,13 +15439,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L785" } ], "type": { @@ -12911,22 +15463,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [968] + "children": [973] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 783, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ] } } }, { - "id": 965, + "id": 970, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12935,7 +15487,8 @@ { "fileName": "src/lib/types.ts", "line": 782, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L782" } ], "type": { @@ -12944,7 +15497,7 @@ } }, { - "id": 964, + "id": 969, "name": "type", "kind": 1024, "kindString": "Property", @@ -12953,7 +15506,8 @@ { "fileName": "src/lib/types.ts", "line": 781, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L781" } ], "type": { @@ -12961,7 +15515,7 @@ "typeArguments": [ { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" }, { @@ -12978,24 +15532,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [966, 965, 964] + "children": [971, 970, 969] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 780, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L780" } ] } @@ -13015,9 +15569,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13032,7 +15586,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2111" } ], "signatures": [ @@ -13043,7 +15598,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Sends a password reset request to an email address. This method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -13053,7 +15613,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The email address of the user." + "summary": [ + { + "kind": "text", + "text": "The email address of the user." + } + ] }, "type": { "type": "intrinsic", @@ -13084,13 +15649,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2115" } ], "type": { @@ -13107,13 +15678,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL to send the user to after they click the password reset link." + "summary": [ + { + "kind": "text", + "text": "The URL to send the user to after they click the password reset link." + } + ] }, "sources": [ { "fileName": "src/GoTrueClient.ts", "line": 2114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2114" } ], "type": { @@ -13125,9 +15702,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [396, 395] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2113, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2113" + } ] } }, @@ -13159,7 +15743,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2119" } ], "type": { @@ -13183,7 +15768,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2120, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2120" } ], "type": { @@ -13195,9 +15781,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [398, 400] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2118, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2118" + } ] } }, @@ -13220,7 +15813,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { @@ -13238,12 +15832,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2122, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -13251,18 +15846,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [402, 403] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2122, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2122" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13277,7 +15879,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1729, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" } ], "signatures": [ @@ -13288,7 +15891,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + "summary": [ + { + "kind": "text", + "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + } + ] }, "parameters": [ { @@ -13298,7 +15906,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The current session that minimally contains an access token and refresh token.\n" + "summary": [ + { + "kind": "text", + "text": "The current session that minimally contains an access token and refresh token." + } + ] }, "type": { "type": "reflection", @@ -13319,7 +15932,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1730, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1730" } ], "type": { @@ -13337,7 +15951,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1731, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1731" } ], "type": { @@ -13349,9 +15964,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [317, 318] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1729, + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1729" + } ] } } @@ -13366,9 +15988,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13383,7 +16005,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 456, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L456" } ], "signatures": [ @@ -13394,8 +16017,23 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new anonymous user.", - "returns": "A session where the is_anonymous claim in the access token JWT set to true\n" + "summary": [ + { + "kind": "text", + "text": "Creates a new anonymous user." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A session where the is_anonymous claim in the access token JWT set to true" + } + ] + } + ] }, "parameters": [ { @@ -13408,10 +16046,10 @@ }, "type": { "type": "reference", - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13420,20 +16058,21 @@ { "fileName": "src/lib/types.ts", "line": 490, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ], "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 812, "name": "options", "kind": 1024, "kindString": "Property", @@ -13444,20 +16083,21 @@ { "fileName": "src/lib/types.ts", "line": 491, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ], "type": { "type": "reflection", "declaration": { - "id": 811, + "id": 813, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 813, + "id": 815, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13465,13 +16105,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 499, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L499" } ], "type": { @@ -13480,7 +16126,7 @@ } }, { - "id": 812, + "id": 814, "name": "data", "kind": 1024, "kindString": "Property", @@ -13488,14 +16134,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 497, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L497" } ], "type": { @@ -13507,15 +16174,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [813, 812] + "children": [815, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 491, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ] } @@ -13525,15 +16192,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [810] + "children": [812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 490, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ] } @@ -13551,9 +16218,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13568,7 +16235,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1064, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1064" } ], "signatures": [ @@ -13579,7 +16247,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + "summary": [ + { + "kind": "text", + "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." + } + ] }, "parameters": [ { @@ -13590,10 +16263,10 @@ "flags": {}, "type": { "type": "reference", - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13602,20 +16275,21 @@ { "fileName": "src/lib/types.ts", "line": 617, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ], "type": { "type": "reflection", "declaration": { - "id": 875, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 881, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -13623,13 +16297,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L623" } ], "type": { @@ -13638,7 +16326,7 @@ } }, { - "id": 880, + "id": 882, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -13646,13 +16334,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L625" } ], "type": { @@ -13661,7 +16363,7 @@ } }, { - "id": 881, + "id": 883, "name": "options", "kind": 1024, "kindString": "Property", @@ -13672,20 +16374,21 @@ { "fileName": "src/lib/types.ts", "line": 626, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ], "type": { "type": "reflection", "declaration": { - "id": 882, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 883, + "id": 885, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13693,13 +16396,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 628, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L628" } ], "type": { @@ -13711,34 +16420,96 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [883] + "children": [885] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 626, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ] } } }, { - "id": 876, + "id": 878, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)." + "summary": [ + { + "kind": "text", + "text": "Provider name or OIDC " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " value identifying which provider should be used to verify the provided token. Supported names: " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`apple`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`azure`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`facebook`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`kakao`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`keycloak`" + }, + { + "kind": "text", + "text": " (deprecated)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 619, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ], "type": { @@ -13774,7 +16545,7 @@ { "type": "reflection", "declaration": { - "id": 877, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13783,7 +16554,8 @@ { "fileName": "src/lib/types.ts", "line": 619, - "character": 76 + "character": 76, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ] } @@ -13794,19 +16566,57 @@ } }, { - "id": 878, + "id": 880, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." + "summary": [ + { + "kind": "text", + "text": "OIDC ID token issued by the specified provider. The " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " which require that you provide an " + }, + { + "kind": "code", + "text": "`access_token`" + }, + { + "kind": "text", + "text": " value to be accepted properly. If the token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim you must supply the nonce used to obtain the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 621, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L621" } ], "type": { @@ -13818,15 +16628,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [879, 880, 881, 876, 878] + "children": [881, 882, 883, 878, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 617, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ] } @@ -13844,9 +16654,9 @@ "name": "AuthTokenResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13861,7 +16671,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 639, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L639" } ], "signatures": [ @@ -13872,7 +16683,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + "summary": [ + { + "kind": "text", + "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." + } + ] }, "parameters": [ { @@ -13883,10 +16699,10 @@ "flags": {}, "type": { "type": "reference", - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13895,20 +16711,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -13919,20 +16736,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -13940,19 +16758,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13961,18 +16785,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -13991,7 +16816,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13999,13 +16824,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -14014,7 +16845,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -14022,13 +16853,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -14037,7 +16874,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -14045,13 +16882,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -14063,34 +16906,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -14104,13 +16953,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -14213,15 +17068,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } @@ -14239,9 +17094,9 @@ "name": "OAuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -14256,7 +17111,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1119" } ], "signatures": [ @@ -14267,8 +17123,28 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).", - "text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n" + "summary": [ + { + "kind": "text", + "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " + }, + { + "kind": "code", + "text": "`{{ .ConfirmationURL }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " + }, + { + "kind": "code", + "text": "`{{ .Token }}`" + }, + { + "kind": "text", + "text": " variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed." + } + ] }, "parameters": [ { @@ -14279,10 +17155,10 @@ "flags": {}, "type": { "type": "reference", - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14291,7 +17167,8 @@ { "fileName": "src/lib/types.ts", "line": 563, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L563" } ], "type": { @@ -14300,26 +17177,32 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L566" } ], "type": { @@ -14328,7 +17211,7 @@ } }, { - "id": 847, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -14339,20 +17222,21 @@ { "fileName": "src/lib/types.ts", "line": 567, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ], "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 852, + "id": 854, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14360,13 +17244,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 579, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L579" } ], "type": { @@ -14375,7 +17265,7 @@ } }, { - "id": 851, + "id": 853, "name": "data", "kind": 1024, "kindString": "Property", @@ -14383,14 +17273,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L577" } ], "type": { @@ -14399,7 +17310,7 @@ } }, { - "id": 849, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -14407,13 +17318,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L569" } ], "type": { @@ -14422,7 +17339,7 @@ } }, { - "id": 850, + "id": 852, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -14430,13 +17347,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L571" } ], "type": { @@ -14448,15 +17371,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [852, 851, 849, 850] + "children": [854, 853, 851, 852] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 567, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ] } @@ -14466,15 +17389,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [846, 847] + "children": [848, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 564, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L564" } ] } @@ -14482,14 +17405,14 @@ { "type": "reflection", "declaration": { - "id": 853, + "id": 855, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 855, + "id": 857, "name": "options", "kind": 1024, "kindString": "Property", @@ -14500,20 +17423,21 @@ { "fileName": "src/lib/types.ts", "line": 585, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ], "type": { "type": "reflection", "declaration": { - "id": 856, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 861, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14521,13 +17445,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 595, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L595" } ], "type": { @@ -14536,7 +17466,7 @@ } }, { - "id": 860, + "id": 862, "name": "channel", "kind": 1024, "kindString": "Property", @@ -14544,13 +17474,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 597, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L597" } ], "type": { @@ -14568,7 +17504,7 @@ } }, { - "id": 858, + "id": 860, "name": "data", "kind": 1024, "kindString": "Property", @@ -14576,14 +17512,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 593, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L593" } ], "type": { @@ -14592,7 +17549,7 @@ } }, { - "id": 857, + "id": 859, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -14600,13 +17557,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L587" } ], "type": { @@ -14618,34 +17581,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [859, 860, 858, 857] + "children": [861, 862, 860, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 585, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ] } } }, { - "id": 854, + "id": 856, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 584, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L584" } ], "type": { @@ -14657,15 +17626,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [855, 854] + "children": [857, 856] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 582, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L582" } ] } @@ -14685,9 +17654,9 @@ "name": "AuthOtpResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -14702,7 +17671,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 576, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L576" } ], "signatures": [ @@ -14713,8 +17683,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.", - "text": "Be aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login.\n" + "summary": [ + { + "kind": "text", + "text": "Log in an existing user with an email and password or phone and password.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." + } + ] }, "parameters": [ { @@ -14725,10 +17699,10 @@ "flags": {}, "type": { "type": "reference", - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14737,7 +17711,8 @@ { "fileName": "src/lib/types.ts", "line": 541, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L541" } ], "type": { @@ -14746,26 +17721,32 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 835, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 544, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L544" } ], "type": { @@ -14774,7 +17755,7 @@ } }, { - "id": 835, + "id": 837, "name": "options", "kind": 1024, "kindString": "Property", @@ -14785,20 +17766,21 @@ { "fileName": "src/lib/types.ts", "line": 547, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ], "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14806,13 +17788,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L549" } ], "type": { @@ -14824,34 +17812,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [837] + "children": [839] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 547, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ] } } }, { - "id": 834, + "id": 836, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 546, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L546" } ], "type": { @@ -14863,15 +17857,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [833, 835, 834] + "children": [835, 837, 836] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 542, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L542" } ] } @@ -14879,14 +17873,14 @@ { "type": "reflection", "declaration": { - "id": 838, + "id": 840, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 843, "name": "options", "kind": 1024, "kindString": "Property", @@ -14897,20 +17891,21 @@ { "fileName": "src/lib/types.ts", "line": 557, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 843, + "id": 845, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14918,13 +17913,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L559" } ], "type": { @@ -14936,34 +17937,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [843] + "children": [845] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 557, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ] } } }, { - "id": 840, + "id": 842, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 556, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L556" } ], "type": { @@ -14972,19 +17979,25 @@ } }, { - "id": 839, + "id": 841, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 554, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L554" } ], "type": { @@ -14996,15 +18009,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [841, 840, 839] + "children": [843, 842, 841] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 552, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L552" } ] } @@ -15024,9 +18037,9 @@ "name": "AuthTokenResponsePassword" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15041,7 +18054,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1233, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1233" } ], "signatures": [ @@ -15052,8 +18066,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", - "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n" + "summary": [ + { + "kind": "text", + "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." + } + ] }, "parameters": [ { @@ -15064,10 +18082,10 @@ "flags": {}, "type": { "type": "reference", - "id": 969, + "id": 974, "name": "SignInWithSSO", "dereferenced": { - "id": 969, + "id": 974, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -15076,7 +18094,8 @@ { "fileName": "src/lib/types.ts", "line": 789, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L789" } ], "type": { @@ -15085,14 +18104,14 @@ { "type": "reflection", "declaration": { - "id": 970, + "id": 975, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 972, + "id": 977, "name": "options", "kind": 1024, "kindString": "Property", @@ -15103,20 +18122,21 @@ { "fileName": "src/lib/types.ts", "line": 794, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ], "type": { "type": "reflection", "declaration": { - "id": 973, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 975, + "id": 980, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15124,13 +18144,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 798, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L798" } ], "type": { @@ -15139,7 +18165,7 @@ } }, { - "id": 974, + "id": 979, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -15147,13 +18173,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L796" } ], "type": { @@ -15165,34 +18197,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [975, 974] + "children": [980, 979] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ] } } }, { - "id": 971, + "id": 976, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." + "summary": [ + { + "kind": "text", + "text": "UUID of the SSO provider to invoke single-sign on to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 792, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L792" } ], "type": { @@ -15204,15 +18242,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [972, 971] + "children": [977, 976] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 790, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L790" } ] } @@ -15220,26 +18258,32 @@ { "type": "reflection", "declaration": { - "id": 976, + "id": 981, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 977, + "id": 982, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." + "summary": [ + { + "kind": "text", + "text": "Domain name of the organization for which to invoke single-sign on." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 803, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L803" } ], "type": { @@ -15248,7 +18292,7 @@ } }, { - "id": 978, + "id": 983, "name": "options", "kind": 1024, "kindString": "Property", @@ -15259,20 +18303,21 @@ { "fileName": "src/lib/types.ts", "line": 805, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ], "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 984, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 981, + "id": 986, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15280,13 +18325,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 809, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L809" } ], "type": { @@ -15295,7 +18346,7 @@ } }, { - "id": 980, + "id": 985, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -15303,13 +18354,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L807" } ], "type": { @@ -15321,15 +18378,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [981, 980] + "children": [986, 985] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 805, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ] } @@ -15339,15 +18396,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [977, 978] + "children": [982, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 801, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L801" } ] } @@ -15367,9 +18424,9 @@ "name": "SSOResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15384,7 +18441,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 666, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L666" } ], "signatures": [ @@ -15395,11 +18453,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side.", - "tags": [ + "summary": [ { - "tag": "reference", - "text": "https://eips.ethereum.org/EIPS/eip-4361\n" + "kind": "text", + "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." + } + ], + "blockTags": [ + { + "tag": "@reference", + "content": [ + { + "kind": "text", + "text": "https://eips.ethereum.org/EIPS/eip-4361" + } + ] } ] }, @@ -15412,10 +18480,10 @@ "flags": {}, "type": { "type": "reference", - "id": 932, + "id": 937, "name": "Web3Credentials", "dereferenced": { - "id": 932, + "id": 937, "name": "Web3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -15424,14 +18492,15 @@ { "fileName": "src/lib/types.ts", "line": 717, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L717" } ], "type": { "type": "union", "types": [ { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -15440,7 +18509,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -15449,14 +18519,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -15465,7 +18535,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -15474,7 +18545,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -15485,20 +18556,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15506,13 +18578,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -15521,7 +18599,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -15532,7 +18610,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -15571,18 +18650,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -15590,13 +18669,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -15608,22 +18693,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -15631,13 +18716,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -15646,7 +18737,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -15654,18 +18745,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -15673,15 +18778,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -15689,14 +18794,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -15705,7 +18810,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -15714,19 +18820,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -15735,7 +18871,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -15746,20 +18882,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15767,13 +18904,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -15785,56 +18928,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -15843,7 +18992,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -15852,7 +19001,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -15861,14 +19011,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -15877,7 +19027,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -15886,7 +19037,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -15897,20 +19048,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15918,13 +19070,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -15933,7 +19091,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -15944,7 +19102,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -15979,18 +19138,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -15998,13 +19157,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -16016,22 +19181,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -16039,13 +19204,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -16054,7 +19225,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -16062,18 +19233,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -16081,15 +19266,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -16097,14 +19282,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -16113,7 +19298,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -16122,19 +19308,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -16143,7 +19359,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -16154,20 +19370,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16175,13 +19392,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -16193,34 +19416,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -16232,15 +19461,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -16279,7 +19508,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -16301,7 +19531,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -16320,7 +19551,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 668, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" } ], "type": { @@ -16333,9 +19565,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [166, 167] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 668, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L668" + } ] } } @@ -16350,7 +19589,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 669, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L669" } ], "type": { @@ -16362,9 +19602,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [164, 168] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 667, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L667" + } ] } }, @@ -16387,7 +19634,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -16409,7 +19657,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -16427,7 +19676,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { @@ -16439,9 +19689,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [172, 173] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } @@ -16456,12 +19713,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 671, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -16469,18 +19727,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [170, 174] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 671, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L671" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16495,7 +19760,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "signatures": [ @@ -16506,8 +19772,52 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n" + "summary": [ + { + "kind": "text", + "text": "Inside a browser context, " + }, + { + "kind": "code", + "text": "`signOut()`" + }, + { + "kind": "text", + "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " + }, + { + "kind": "code", + "text": "`\"SIGNED_OUT\"`" + }, + { + "kind": "text", + "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " + }, + { + "kind": "code", + "text": "`auth.api.signOut(JWT: string)`" + }, + { + "kind": "text", + "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " + }, + { + "kind": "code", + "text": "`others`" + }, + { + "kind": "text", + "text": " scope, no " + }, + { + "kind": "code", + "text": "`SIGNED_OUT`" + }, + { + "kind": "text", + "text": " event is fired!" + } + ] }, "parameters": [ { @@ -16518,10 +19828,10 @@ "flags": {}, "type": { "type": "reference", - "id": 1183, + "id": 1188, "name": "SignOut", "dereferenced": { - "id": 1183, + "id": 1188, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -16530,20 +19840,21 @@ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ], "type": { "type": "reflection", "declaration": { - "id": 1184, + "id": 1189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1185, + "id": 1190, "name": "scope", "kind": 1024, "kindString": "Property", @@ -16551,13 +19862,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + "summary": [ + { + "kind": "text", + "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1231, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1231" } ], "type": { @@ -16582,15 +19899,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1185] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ] } @@ -16622,7 +19939,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2011, - "character": 67 + "character": 67, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" } ], "type": { @@ -16634,7 +19952,7 @@ }, { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } ] @@ -16644,16 +19962,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [370] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2011, + "character": 65, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2011" + } ] } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16668,7 +19993,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 499, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L499" } ], "signatures": [ @@ -16679,9 +20005,32 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "Be aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\n", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" + "summary": [ + { + "kind": "text", + "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A logged-in session if the server has \"autoconfirm\" ON" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A user if the server has \"autoconfirm\" OFF" + } + ] + } + ] }, "parameters": [ { @@ -16692,10 +20041,10 @@ "flags": {}, "type": { "type": "reference", - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16704,7 +20053,8 @@ { "fileName": "src/lib/types.ts", "line": 503, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L503" } ], "type": { @@ -16713,26 +20063,32 @@ { "type": "reflection", "declaration": { - "id": 815, + "id": 817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 818, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 506, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L506" } ], "type": { @@ -16741,7 +20097,7 @@ } }, { - "id": 818, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -16752,20 +20108,21 @@ { "fileName": "src/lib/types.ts", "line": 509, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ], "type": { "type": "reflection", "declaration": { - "id": 819, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 822, + "id": 824, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16773,13 +20130,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 519, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L519" } ], "type": { @@ -16788,7 +20151,7 @@ } }, { - "id": 821, + "id": 823, "name": "data", "kind": 1024, "kindString": "Property", @@ -16796,14 +20159,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 517, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L517" } ], "type": { @@ -16812,7 +20196,7 @@ } }, { - "id": 820, + "id": 822, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -16820,13 +20204,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L511" } ], "type": { @@ -16838,34 +20228,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [822, 821, 820] + "children": [824, 823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 509, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ] } } }, { - "id": 817, + "id": 819, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L508" } ], "type": { @@ -16877,15 +20273,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [816, 818, 817] + "children": [818, 820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 504, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L504" } ] } @@ -16893,14 +20289,14 @@ { "type": "reflection", "declaration": { - "id": 823, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 826, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -16911,20 +20307,21 @@ { "fileName": "src/lib/types.ts", "line": 527, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16932,13 +20329,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L535" } ], "type": { @@ -16947,7 +20350,7 @@ } }, { - "id": 830, + "id": 832, "name": "channel", "kind": 1024, "kindString": "Property", @@ -16955,13 +20358,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 537, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L537" } ], "type": { @@ -16979,7 +20388,7 @@ } }, { - "id": 828, + "id": 830, "name": "data", "kind": 1024, "kindString": "Property", @@ -16987,14 +20396,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L533" } ], "type": { @@ -17006,34 +20436,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [829, 830, 828] + "children": [831, 832, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 527, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ] } } }, { - "id": 825, + "id": 827, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 526, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L526" } ], "type": { @@ -17042,19 +20478,25 @@ } }, { - "id": 824, + "id": 826, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 524, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L524" } ], "type": { @@ -17066,15 +20508,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [826, 825, 824] + "children": [828, 827, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 522, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L522" } ] } @@ -17094,9 +20536,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -17111,7 +20553,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2698, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2698" } ], "signatures": [ @@ -17122,8 +20565,26 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.", - "text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n" + "summary": [ + { + "kind": "text", + "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClientOptions#autoRefreshToken" + }, + { + "kind": "text", + "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "#stopAutoRefresh" + } + ] }, "type": { "type": "reference", @@ -17133,9 +20594,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -17150,7 +20611,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2711, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2711" } ], "signatures": [ @@ -17161,8 +20623,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).", - "text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n" + "summary": [ + { + "kind": "text", + "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#startAutoRefresh", + "target": 0 + }, + { + "kind": "text", + "text": " for more details." + } + ] }, "type": { "type": "reference", @@ -17172,9 +20648,9 @@ "name": "void" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -17189,7 +20665,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2217, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2217" } ], "signatures": [ @@ -17200,7 +20677,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + "summary": [ + { + "kind": "text", + "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." + } + ] }, "parameters": [ { @@ -17232,7 +20714,8 @@ { "fileName": "src/lib/types.ts", "line": 300, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L300" } ], "type": { @@ -17250,7 +20733,8 @@ { "fileName": "src/lib/types.ts", "line": 293, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L293" } ], "type": { @@ -17270,7 +20754,8 @@ { "fileName": "src/lib/types.ts", "line": 295, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" } ], "type": { @@ -17281,6 +20766,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" + } + ], "indexSignature": { "id": 733, "name": "__index", @@ -17317,7 +20810,8 @@ { "fileName": "src/lib/types.ts", "line": 298, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L298" } ], "type": { @@ -17337,7 +20831,8 @@ { "fileName": "src/lib/types.ts", "line": 301, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L301" } ], "type": { @@ -17355,7 +20850,8 @@ { "fileName": "src/lib/types.ts", "line": 299, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L299" } ], "type": { @@ -17375,7 +20871,8 @@ { "fileName": "src/lib/types.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L302" } ], "type": { @@ -17393,7 +20890,8 @@ { "fileName": "src/lib/types.ts", "line": 294, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L294" } ], "type": { @@ -17405,7 +20903,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [737, 729, 731, 735, 738, 736, 739, 730] } ], @@ -17413,7 +20910,8 @@ { "fileName": "src/lib/types.ts", "line": 292, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L292" } ] } @@ -17445,7 +20943,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2219, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2219" } ], "type": { @@ -17469,7 +20968,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2220, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2220" } ], "type": { @@ -17481,9 +20981,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [421, 423] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2218, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2218" + } ] } }, @@ -17506,7 +21013,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { @@ -17524,12 +21032,13 @@ { "fileName": "src/GoTrueClient.ts", "line": 2222, - "character": 20 + "character": 20, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -17537,18 +21046,25 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [425, 426] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 2222, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L2222" + } ] } } ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -17563,7 +21079,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1660, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1660" } ], "signatures": [ @@ -17574,7 +21091,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates user data for a logged in user." + "summary": [ + { + "kind": "text", + "text": "Updates user data for a logged in user." + } + ] }, "parameters": [ { @@ -17603,14 +21125,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 397, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L397" } ], "type": { @@ -17627,13 +21170,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -17650,14 +21199,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -17674,13 +21228,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -17697,13 +21257,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -17715,7 +21281,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [786, 782, 785, 784, 783] } ], @@ -17723,7 +21288,8 @@ { "fileName": "src/lib/types.ts", "line": 368, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L368" } ] } @@ -17756,7 +21322,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1663, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1663" } ], "type": { @@ -17768,9 +21335,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [306] } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 1662, + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1662" + } ] } }, @@ -17786,9 +21360,9 @@ "name": "UserResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -17803,7 +21377,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 1172, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L1172" } ], "signatures": [ @@ -17814,7 +21389,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + "summary": [ + { + "kind": "text", + "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." + } + ] }, "parameters": [ { @@ -17825,10 +21405,10 @@ "flags": {}, "type": { "type": "reference", - "id": 933, + "id": 938, "name": "VerifyOtpParams", "dereferenced": { - "id": 933, + "id": 938, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -17837,21 +21417,22 @@ { "fileName": "src/lib/types.ts", "line": 719, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L719" } ], "type": { "type": "union", "types": [ { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -17862,20 +21443,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17883,11 +21465,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -17895,7 +21482,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -17904,7 +21492,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17912,13 +21500,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -17930,27 +21524,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -17959,19 +21566,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -17980,27 +21593,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -18009,7 +21628,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -18032,39 +21652,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -18073,7 +21699,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -18084,20 +21710,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18105,11 +21732,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "\n" + "tag": "@deprecated", + "content": [] } ] }, @@ -18117,7 +21749,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -18126,7 +21759,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18134,13 +21767,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -18152,27 +21791,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -18181,27 +21833,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -18210,7 +21868,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -18249,39 +21908,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -18290,27 +21955,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -18319,7 +21990,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -18358,15 +22030,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] } @@ -18385,9 +22057,9 @@ "name": "AuthResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -18396,17 +22068,14 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [80] }, { "title": "Properties", - "kind": 1024, "children": [84, 85] }, { "title": "Methods", - "kind": 2048, "children": [ 157, 523, 232, 295, 404, 141, 414, 376, 225, 325, 229, 390, 313, 145, 213, 154, 216, 151, 222, 160, 366, 148, 472, 474, 417, 301, 219 @@ -18417,7 +22086,8 @@ { "fileName": "src/GoTrueClient.ts", "line": 158, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/GoTrueClient.ts#L158" } ] }, @@ -18434,6 +22104,14 @@ "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 26, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L26" + } + ], "signatures": [ { "id": 558, @@ -18483,7 +22161,8 @@ { "fileName": "src/lib/locks.ts", "line": 24, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L24" } ], "type": { @@ -18500,12 +22179,10 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [557] }, { "title": "Properties", - "kind": 1024, "children": [560] } ], @@ -18513,7 +22190,8 @@ { "fileName": "src/lib/locks.ts", "line": 31, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L31" } ], "extendedTypes": [ @@ -18530,12 +22208,27 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "An authentication methord reference (AMR) entry.", - "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" + "kind": "text", + "text": "An authentication methord reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "." + } + ] } ] }, @@ -18547,13 +22240,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Authentication method name." + "summary": [ + { + "kind": "text", + "text": "Authentication method name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 283, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L283" } ], "type": { @@ -18604,13 +22303,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + "summary": [ + { + "kind": "text", + "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 289, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L289" } ], "type": { @@ -18622,7 +22327,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [725, 727] } ], @@ -18630,7 +22334,8 @@ { "fileName": "src/lib/types.ts", "line": 281, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L281" } ] }, @@ -18650,14 +22355,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's application specific metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.app_metadata`" + }, + { + "kind": "text", + "text": " column.\n\nOnly a service role can modify.\n\nThe " + }, + { + "kind": "code", + "text": "`app_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 421, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L421" } ], "type": { @@ -18674,14 +22400,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + "summary": [ + { + "kind": "text", + "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 447, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L447" } ], "type": { @@ -18698,13 +22429,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -18725,14 +22462,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's email address if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 428, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L428" } ], "type": { @@ -18749,14 +22491,35 @@ "isOptional": true }, "comment": { - "shortText": "The `id` for the user.", - "text": "Allows you to overwrite the default `id` set for the user.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " for the user.\n\nAllows you to overwrite the default " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " set for the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 472, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L472" } ], "type": { @@ -18773,14 +22536,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -18801,13 +22569,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -18828,14 +22602,27 @@ "isOptional": true }, "comment": { - "shortText": "The `password_hash` for the user's password.", - "text": "Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`password_hash`" + }, + { + "kind": "text", + "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 465, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L465" } ], "type": { @@ -18852,13 +22639,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -18879,14 +22672,19 @@ "isOptional": true }, "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" + "summary": [ + { + "kind": "text", + "text": "Confirms the user's phone number if set to true.\n\nOnly a service role can modify." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 435, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L435" } ], "type": { @@ -18903,14 +22701,51 @@ "isOptional": true }, "comment": { - "shortText": "The `role` claim set in the user's access token JWT.", - "text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n" + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " + }, + { + "kind": "code", + "text": "`authenticated`" + }, + { + "kind": "text", + "text": " by default. You should only modify the " + }, + { + "kind": "code", + "text": "`role`" + }, + { + "kind": "text", + "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " + }, + { + "kind": "code", + "text": "`service_role`" + }, + { + "kind": "text", + "text": " is not recommended as it grants the user admin privileges." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 456, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L456" } ], "type": { @@ -18927,14 +22762,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\n\nThe " + }, + { + "kind": "code", + "text": "`user_metadata`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L411" } ], "type": { @@ -18946,7 +22802,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [789, 792, 799, 790, 795, 797, 796, 794, 798, 791, 793, 788] } ], @@ -18954,7 +22809,8 @@ { "fileName": "src/lib/types.ts", "line": 400, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L400" } ], "extendedTypes": [ @@ -18971,9 +22827,9 @@ "value": "data" } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ] }, @@ -18984,19 +22840,58 @@ "kindString": "Interface", "flags": {}, "comment": { - "shortText": "A MFA factor.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#listFactors}" - }, + "kind": "text", + "text": "A MFA factor." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAAdminApi#listFactors}\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "listFactors", + "target": 1128 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueMFAAdminApi#listFactors" + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -19011,7 +22906,8 @@ { "fileName": "src/lib/types.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L327" } ], "type": { @@ -19026,13 +22922,35 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of factor. `totp` and `phone` supported with this version" + "summary": [ + { + "kind": "text", + "text": "Type of factor. " + }, + { + "kind": "code", + "text": "`totp`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`phone`" + }, + { + "kind": "text", + "text": " supported with this version" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L322" } ], "type": { @@ -19077,13 +22995,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful to disambiguate between multiple factors." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L317" } ], "type": { @@ -19098,13 +23022,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor." + "summary": [ + { + "kind": "text", + "text": "ID of the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 314, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L314" } ], "type": { @@ -19119,13 +23049,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor's status." + "summary": [ + { + "kind": "text", + "text": "Factor's status." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 325, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L325" } ], "type": { @@ -19152,7 +23088,8 @@ { "fileName": "src/lib/types.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L328" } ], "type": { @@ -19164,7 +23101,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [746, 743, 742, 741, 745, 747] } ], @@ -19172,19 +23108,20 @@ { "fileName": "src/lib/types.ts", "line": 312, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L312" } ] }, { - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1005, + "id": 1010, "name": "data", "kind": 1024, "kindString": "Property", @@ -19192,14 +23129,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 851, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L851" } ], "type": { @@ -19208,7 +23166,7 @@ } }, { - "id": 1006, + "id": 1011, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19216,13 +23174,19 @@ "isOptional": true }, "comment": { - "shortText": "The URL which will be appended to the email link generated." + "summary": [ + { + "kind": "text", + "text": "The URL which will be appended to the email link generated." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 853, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L853" } ], "type": { @@ -19234,82 +23198,108 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1005, 1006] + "children": [1010, 1011] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 845, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L845" } ] }, { - "id": 1152, + "id": 1157, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ + "summary": [ { - "tag": "expermental", - "text": "\n" + "kind": "text", + "text": "Contains the full multi-factor authentication administration API." + } + ], + "blockTags": [ + { + "tag": "@expermental", + "content": [] } ] }, "children": [ { - "id": 1156, + "id": 1161, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1169, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1169" + } + ], "signatures": [ { - "id": 1157, + "id": 1162, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" + "kind": "text", + "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." + } + ], + "blockTags": [ + { + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "unenroll", + "target": 1122 + } + ] }, { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, "parameters": [ { - "id": 1158, + "id": 1163, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -19317,32 +23307,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -19351,19 +23348,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -19375,15 +23378,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } @@ -19397,55 +23400,69 @@ "typeArguments": [ { "type": "reference", - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1153, + "id": 1158, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1159, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1159" + } + ], "signatures": [ { - "id": 1154, + "id": 1159, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all factors associated to a user." + "summary": [ + { + "kind": "text", + "text": "Lists all factors associated to a user." + } + ] }, "parameters": [ { - "id": 1155, + "id": 1160, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -19453,32 +23470,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -19490,15 +23514,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } @@ -19512,13 +23536,13 @@ "typeArguments": [ { "type": "reference", - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -19527,57 +23551,75 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1156, 1153] + "children": [1161, 1158] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1154, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1154" } ] }, { - "id": 1103, + "id": 1108, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", "flags": {}, "comment": { - "shortText": "Contains the full multi-factor authentication API." + "summary": [ + { + "kind": "text", + "text": "Contains the full multi-factor authentication API." + } + ] }, "children": [ { - "id": 1111, + "id": 1116, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1058, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1058" + } + ], "signatures": [ { - "id": 1112, + "id": 1117, "name": "challenge", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + "summary": [ + { + "kind": "text", + "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + } + ] }, "parameters": [ { - "id": 1113, + "id": 1118, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "dereferenced": { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -19586,20 +23628,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -19607,13 +23650,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -19631,19 +23680,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -19655,15 +23710,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } @@ -19677,46 +23732,59 @@ "typeArguments": [ { "type": "reference", - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1120, + "id": 1125, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1076, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1076" + } + ], "signatures": [ { - "id": 1121, + "id": 1126, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1122, + "id": 1127, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -19725,32 +23793,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -19759,19 +23834,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -19783,15 +23864,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } @@ -19805,47 +23886,87 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1104, + "id": 1109, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1050, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1050" + }, + { + "fileName": "src/lib/types.ts", + "line": 1051, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1051" + }, + { + "fileName": "src/lib/types.ts", + "line": 1052, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1052" + } + ], "signatures": [ { - "id": 1105, + "id": 1110, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + "summary": [ + { + "kind": "text", + "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " + }, + { + "kind": "code", + "text": "`unverified`" + }, + { + "kind": "text", + "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 1106, + "id": 1111, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -19854,32 +23975,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -19888,7 +24016,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -19896,13 +24024,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -19911,7 +24045,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -19919,13 +24053,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -19937,15 +24077,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } @@ -19959,34 +24099,34 @@ "typeArguments": [ { "type": "reference", - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1107, + "id": 1112, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1108, + "id": 1113, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "dereferenced": { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -19995,32 +24135,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -20029,7 +24176,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -20037,13 +24184,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -20052,19 +24205,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -20076,15 +24235,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -20098,34 +24257,34 @@ "typeArguments": [ { "type": "reference", - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } }, { - "id": 1109, + "id": 1114, "name": "enroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1110, + "id": 1115, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "dereferenced": { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -20134,14 +24293,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -20150,32 +24310,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -20184,7 +24351,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -20192,13 +24359,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -20207,7 +24380,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -20215,13 +24388,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -20233,22 +24412,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -20257,32 +24436,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -20291,7 +24477,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -20299,13 +24485,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -20314,19 +24506,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -20338,15 +24536,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -20363,77 +24561,161 @@ "typeArguments": [ { "type": "reference", - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1125, + "id": 1130, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1101, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1101" + } + ], "signatures": [ { - "id": 1126, + "id": 1131, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + "summary": [ + { + "kind": "text", + "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " + }, + { + "kind": "code", + "text": "`aal1`" + }, + { + "kind": "text", + "text": " (or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors." + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1123, + "id": 1128, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1086, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1086" + } + ], "signatures": [ { - "id": 1124, + "id": 1129, "name": "listFactors", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the list of MFA factors enabled for this user.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, + "summary": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, + "kind": "text", + "text": "Returns the list of MFA factors enabled for this user." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" + "tag": "@see", + "content": [ + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "enroll", + "target": 1109 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getAuthenticatorAssuranceLevel", + "target": 1130 + }, + { + "kind": "text", + "text": "\n" + }, + { + "kind": "text", + "text": " - " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getUser", + "target": 295 + }, + { + "kind": "text", + "text": "\n" + } + ] } ] }, @@ -20442,46 +24724,75 @@ "typeArguments": [ { "type": "reference", - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1117, + "id": 1122, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1070, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1070" + } + ], "signatures": [ { - "id": 1118, + "id": 1123, "name": "unenroll", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + "summary": [ + { + "kind": "text", + "text": "Unenroll removes a MFA factor.\nA user has to have an " + }, + { + "kind": "code", + "text": "`aal2`" + }, + { + "kind": "text", + "text": " authenticator level in order to unenroll a " + }, + { + "kind": "code", + "text": "`verified`" + }, + { + "kind": "text", + "text": " factor." + } + ] }, "parameters": [ { - "id": 1119, + "id": 1124, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "dereferenced": { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -20490,32 +24801,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -20527,15 +24845,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } @@ -20549,46 +24867,59 @@ "typeArguments": [ { "type": "reference", - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 1114, + "id": 1119, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1064, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1064" + } + ], "signatures": [ { - "id": 1115, + "id": 1120, "name": "verify", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + "summary": [ + { + "kind": "text", + "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + } + ] }, "parameters": [ { - "id": 1116, + "id": 1121, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "dereferenced": { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -20597,32 +24928,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -20631,19 +24969,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -20652,19 +24996,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -20676,15 +25026,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } @@ -20698,13 +25048,13 @@ "typeArguments": [ { "type": "reference", - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -20713,27 +25063,27 @@ "groups": [ { "title": "Methods", - "kind": 2048, - "children": [1111, 1120, 1104, 1125, 1123, 1117, 1114] + "children": [1116, 1125, 1109, 1130, 1128, 1122, 1119] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1039, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1039" } ] }, { - "id": 1243, + "id": 1248, "name": "JWK", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1246, + "id": 1251, "name": "alg", "kind": 1024, "kindString": "Property", @@ -20744,7 +25094,8 @@ { "fileName": "src/lib/types.ts", "line": 1332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1332" } ], "type": { @@ -20753,7 +25104,7 @@ } }, { - "id": 1245, + "id": 1250, "name": "key_ops", "kind": 1024, "kindString": "Property", @@ -20762,7 +25113,8 @@ { "fileName": "src/lib/types.ts", "line": 1331, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1331" } ], "type": { @@ -20774,7 +25126,7 @@ } }, { - "id": 1247, + "id": 1252, "name": "kid", "kind": 1024, "kindString": "Property", @@ -20785,7 +25137,8 @@ { "fileName": "src/lib/types.ts", "line": 1333, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1333" } ], "type": { @@ -20794,7 +25147,7 @@ } }, { - "id": 1244, + "id": 1249, "name": "kty", "kind": 1024, "kindString": "Property", @@ -20803,7 +25156,8 @@ { "fileName": "src/lib/types.ts", "line": 1330, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1330" } ], "type": { @@ -20828,26 +25182,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1246, 1245, 1247, 1244] + "children": [1251, 1250, 1252, 1249] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1329, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1329" } ], "indexSignature": { - "id": 1248, + "id": 1253, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1249, + "id": 1254, "name": "key", "kind": 32768, "flags": {}, @@ -20877,13 +25231,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + "summary": [ + { + "kind": "text", + "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 252, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L252" } ], "type": { @@ -20900,13 +25260,19 @@ "isOptional": true }, "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "A timestamp of when the token will expire. Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 264, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L264" } ], "type": { @@ -20921,13 +25287,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 260, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L260" } ], "type": { @@ -20944,13 +25316,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + "summary": [ + { + "kind": "text", + "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L248" } ], "type": { @@ -20976,13 +25354,19 @@ "isOptional": true }, "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + "summary": [ + { + "kind": "text", + "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 243, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L243" } ], "type": { @@ -21006,13 +25390,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "A one-time used refresh token that never expires." + "summary": [ + { + "kind": "text", + "text": "A one-time used refresh token that never expires." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 256, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L256" } ], "type": { @@ -21030,7 +25420,8 @@ { "fileName": "src/lib/types.ts", "line": 265, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L265" } ], "type": { @@ -21045,13 +25436,19 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." + "summary": [ + { + "kind": "text", + "text": "When using a separate user storage, accessing properties of this object will throw an error." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 270, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L270" } ], "type": { @@ -21077,7 +25474,8 @@ { "fileName": "src/lib/types.ts", "line": 351, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L351" } ], "type": { @@ -21095,7 +25493,8 @@ { "fileName": "src/lib/types.ts", "line": 342, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L342" } ], "type": { @@ -21121,7 +25520,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -21133,7 +25533,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -21141,7 +25540,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -21180,7 +25580,8 @@ { "fileName": "src/lib/types.ts", "line": 344, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L344" } ], "type": { @@ -21200,7 +25601,8 @@ { "fileName": "src/lib/types.ts", "line": 345, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L345" } ], "type": { @@ -21220,7 +25622,8 @@ { "fileName": "src/lib/types.ts", "line": 355, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L355" } ], "type": { @@ -21238,7 +25641,8 @@ { "fileName": "src/lib/types.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L354" } ], "type": { @@ -21258,7 +25662,8 @@ { "fileName": "src/lib/types.ts", "line": 365, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L365" } ], "type": { @@ -21278,7 +25683,8 @@ { "fileName": "src/lib/types.ts", "line": 352, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L352" } ], "type": { @@ -21298,7 +25704,8 @@ { "fileName": "src/lib/types.ts", "line": 347, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L347" } ], "type": { @@ -21318,7 +25725,8 @@ { "fileName": "src/lib/types.ts", "line": 356, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L356" } ], "type": { @@ -21338,7 +25746,8 @@ { "fileName": "src/lib/types.ts", "line": 364, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L364" } ], "type": { @@ -21360,7 +25769,8 @@ { "fileName": "src/lib/types.ts", "line": 341, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L341" } ], "type": { @@ -21380,7 +25790,8 @@ { "fileName": "src/lib/types.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L361" } ], "type": { @@ -21404,7 +25815,8 @@ { "fileName": "src/lib/types.ts", "line": 350, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L350" } ], "type": { @@ -21424,7 +25836,8 @@ { "fileName": "src/lib/types.ts", "line": 362, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L362" } ], "type": { @@ -21444,7 +25857,8 @@ { "fileName": "src/lib/types.ts", "line": 363, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L363" } ], "type": { @@ -21464,7 +25878,8 @@ { "fileName": "src/lib/types.ts", "line": 358, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L358" } ], "type": { @@ -21484,7 +25899,8 @@ { "fileName": "src/lib/types.ts", "line": 348, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L348" } ], "type": { @@ -21504,7 +25920,8 @@ { "fileName": "src/lib/types.ts", "line": 349, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L349" } ], "type": { @@ -21524,7 +25941,8 @@ { "fileName": "src/lib/types.ts", "line": 353, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L353" } ], "type": { @@ -21544,7 +25962,8 @@ { "fileName": "src/lib/types.ts", "line": 357, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L357" } ], "type": { @@ -21564,7 +25983,8 @@ { "fileName": "src/lib/types.ts", "line": 346, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L346" } ], "type": { @@ -21584,7 +26004,8 @@ { "fileName": "src/lib/types.ts", "line": 359, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L359" } ], "type": { @@ -21604,7 +26025,8 @@ { "fileName": "src/lib/types.ts", "line": 360, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L360" } ], "type": { @@ -21622,7 +26044,8 @@ { "fileName": "src/lib/types.ts", "line": 343, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L343" } ], "type": { @@ -21639,7 +26062,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -21672,7 +26096,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 766, 757, 759, 760, 770, 769, 780, 767, 762, 771, 779, 756, 776, 765, 777, 778, 773, 763, 764, 768, 772, 761, 774, 775, 758 @@ -21683,7 +26106,8 @@ { "fileName": "src/lib/types.ts", "line": 340, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L340" } ] } @@ -21693,7 +26117,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [718, 721, 720, 717, 716, 719, 722, 723] } ], @@ -21701,7 +26124,8 @@ { "fileName": "src/lib/types.ts", "line": 239, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L239" } ] }, @@ -21712,201 +26136,189 @@ "kindString": "Interface", "flags": {}, "children": [ - { - "id": 801, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 802, "name": "callback", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 483, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" } ], - "signatures": [ - { + "type": { + "type": "reflection", + "declaration": { "id": 803, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 483, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L483" + } + ], + "signatures": [ { "id": 804, - "name": "event", - "kind": 32768, - "kindString": "Parameter", + "name": "__type", + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "type": { - "type": "reference", - "id": 574, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 574, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The function to call every time there is an event. eg: (eventName) => {}" + } + ] + }, + "parameters": [ + { + "id": 805, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 574, + "name": "AuthChangeEvent" + } + }, + { + "id": 806, + "name": "session", + "kind": 32768, + "kindString": "Parameter", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], "type": { "type": "union", "types": [ { "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" + "value": null }, { - "id": 573, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } + "type": "reference", + "id": 715, + "name": "Session" } ] } } - } - }, - { - "id": 805, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, + ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 715, - "name": "Session" - } - ] + "type": "intrinsic", + "name": "void" } } - ], - "type": { - "type": "intrinsic", - "name": "void" + ] + } + } + }, + { + "id": 801, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subscriber UUID. This will be set by the client." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L479" } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 806, + "id": 807, "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 487, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" } ], - "signatures": [ - { - "id": 807, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 15, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L487" + } + ], + "signatures": [ + { + "id": 809, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Call this to remove the listener." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [801] - }, - { - "title": "Methods", - "kind": 2048, - "children": [802, 806] + "children": [802, 801, 807] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 475, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L475" } ] }, @@ -21929,7 +26341,8 @@ { "fileName": "src/lib/types.ts", "line": 351, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L351" } ], "type": { @@ -21947,7 +26360,8 @@ { "fileName": "src/lib/types.ts", "line": 342, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L342" } ], "type": { @@ -21973,7 +26387,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -21985,7 +26400,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -21993,7 +26407,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -22032,7 +26447,8 @@ { "fileName": "src/lib/types.ts", "line": 344, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L344" } ], "type": { @@ -22052,7 +26468,8 @@ { "fileName": "src/lib/types.ts", "line": 345, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L345" } ], "type": { @@ -22072,7 +26489,8 @@ { "fileName": "src/lib/types.ts", "line": 355, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L355" } ], "type": { @@ -22090,7 +26508,8 @@ { "fileName": "src/lib/types.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L354" } ], "type": { @@ -22110,7 +26529,8 @@ { "fileName": "src/lib/types.ts", "line": 365, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L365" } ], "type": { @@ -22130,7 +26550,8 @@ { "fileName": "src/lib/types.ts", "line": 352, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L352" } ], "type": { @@ -22150,7 +26571,8 @@ { "fileName": "src/lib/types.ts", "line": 347, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L347" } ], "type": { @@ -22170,7 +26592,8 @@ { "fileName": "src/lib/types.ts", "line": 356, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L356" } ], "type": { @@ -22190,7 +26613,8 @@ { "fileName": "src/lib/types.ts", "line": 364, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L364" } ], "type": { @@ -22212,7 +26636,8 @@ { "fileName": "src/lib/types.ts", "line": 341, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L341" } ], "type": { @@ -22232,7 +26657,8 @@ { "fileName": "src/lib/types.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L361" } ], "type": { @@ -22256,7 +26682,8 @@ { "fileName": "src/lib/types.ts", "line": 350, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L350" } ], "type": { @@ -22276,7 +26703,8 @@ { "fileName": "src/lib/types.ts", "line": 362, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L362" } ], "type": { @@ -22296,7 +26724,8 @@ { "fileName": "src/lib/types.ts", "line": 363, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L363" } ], "type": { @@ -22316,7 +26745,8 @@ { "fileName": "src/lib/types.ts", "line": 358, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L358" } ], "type": { @@ -22336,7 +26766,8 @@ { "fileName": "src/lib/types.ts", "line": 348, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L348" } ], "type": { @@ -22356,7 +26787,8 @@ { "fileName": "src/lib/types.ts", "line": 349, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L349" } ], "type": { @@ -22376,7 +26808,8 @@ { "fileName": "src/lib/types.ts", "line": 353, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L353" } ], "type": { @@ -22396,7 +26829,8 @@ { "fileName": "src/lib/types.ts", "line": 357, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L357" } ], "type": { @@ -22416,7 +26850,8 @@ { "fileName": "src/lib/types.ts", "line": 346, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L346" } ], "type": { @@ -22436,7 +26871,8 @@ { "fileName": "src/lib/types.ts", "line": 359, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L359" } ], "type": { @@ -22456,7 +26892,8 @@ { "fileName": "src/lib/types.ts", "line": 360, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L360" } ], "type": { @@ -22474,7 +26911,8 @@ { "fileName": "src/lib/types.ts", "line": 343, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L343" } ], "type": { @@ -22491,7 +26929,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -22524,7 +26963,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [ 766, 757, 759, 760, 770, 769, 780, 767, 762, 771, 779, 756, 776, 765, 777, 778, 773, 763, 764, 768, 772, 761, 774, 775, 758 @@ -22535,7 +26973,8 @@ { "fileName": "src/lib/types.ts", "line": 340, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L340" } ] }, @@ -22558,7 +26997,8 @@ { "fileName": "src/lib/types.ts", "line": 332, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L332" } ], "type": { @@ -22570,7 +27010,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [749] } ], @@ -22578,7 +27017,8 @@ { "fileName": "src/lib/types.ts", "line": 331, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L331" } ], "indexSignature": { @@ -22621,14 +27061,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 397, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L397" } ], "type": { @@ -22645,13 +27106,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "summary": [ + { + "kind": "text", + "text": "The user's email." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 372, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L372" } ], "type": { @@ -22668,14 +27135,19 @@ "isOptional": true }, "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.", - "text": "Call reauthenticate() to obtain the nonce first.\n" + "summary": [ + { + "kind": "text", + "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 389, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L389" } ], "type": { @@ -22692,13 +27164,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 382, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L382" } ], "type": { @@ -22715,13 +27193,19 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "summary": [ + { + "kind": "text", + "text": "The user's phone." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 377, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L377" } ], "type": { @@ -22733,7 +27217,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [786, 782, 785, 784, 783] } ], @@ -22741,7 +27224,8 @@ { "fileName": "src/lib/types.ts", "line": 368, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L368" } ] }, @@ -22764,7 +27248,8 @@ { "fileName": "src/lib/types.ts", "line": 300, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L300" } ], "type": { @@ -22782,7 +27267,8 @@ { "fileName": "src/lib/types.ts", "line": 293, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L293" } ], "type": { @@ -22802,7 +27288,8 @@ { "fileName": "src/lib/types.ts", "line": 295, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" } ], "type": { @@ -22813,6 +27300,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L295" + } + ], "indexSignature": { "id": 733, "name": "__index", @@ -22849,7 +27344,8 @@ { "fileName": "src/lib/types.ts", "line": 298, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L298" } ], "type": { @@ -22869,7 +27365,8 @@ { "fileName": "src/lib/types.ts", "line": 301, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L301" } ], "type": { @@ -22887,7 +27384,8 @@ { "fileName": "src/lib/types.ts", "line": 299, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L299" } ], "type": { @@ -22907,7 +27405,8 @@ { "fileName": "src/lib/types.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L302" } ], "type": { @@ -22925,7 +27424,8 @@ { "fileName": "src/lib/types.ts", "line": 294, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L294" } ], "type": { @@ -22937,7 +27437,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [737, 729, 731, 735, 738, 736, 739, 730] } ], @@ -22945,7 +27444,8 @@ { "fileName": "src/lib/types.ts", "line": 292, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L292" } ] }, @@ -22959,7 +27459,8 @@ { "fileName": "src/lib/types.ts", "line": 336, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L336" } ], "indexSignature": { @@ -22987,26 +27488,32 @@ } }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -23015,7 +27522,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -23026,20 +27533,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23047,11 +27555,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -23059,7 +27572,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -23068,7 +27582,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23076,13 +27590,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -23094,27 +27614,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -23123,27 +27656,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23152,7 +27691,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -23191,27 +27731,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -23222,20 +27762,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -23243,11 +27784,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -23255,7 +27801,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -23264,7 +27811,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23272,13 +27819,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -23290,27 +27843,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -23319,19 +27885,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -23340,27 +27912,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23369,7 +27947,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -23392,39 +27971,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -23433,27 +28018,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -23462,7 +28053,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -23501,15 +28093,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] }, @@ -23523,7 +28115,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L34" } ], "type": { @@ -23563,7 +28156,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L32" } ], "type": { @@ -23584,7 +28178,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L32" } ], "type": { @@ -23593,7 +28188,7 @@ } }, { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -23602,7 +28197,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -23620,16 +28216,17 @@ } }, { - "id": 1136, + "id": 1141, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -23637,32 +28234,39 @@ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ], "type": { "type": "reflection", "declaration": { - "id": 1137, + "id": 1142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1138, + "id": 1143, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the MFA factor to delete." + "summary": [ + { + "kind": "text", + "text": "ID of the MFA factor to delete." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1122, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1122" } ], "type": { @@ -23671,19 +28275,25 @@ } }, { - "id": 1139, + "id": 1144, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user whose factor is being deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the user whose factor is being deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1125, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1125" } ], "type": { @@ -23695,31 +28305,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1138, 1139] + "children": [1143, 1144] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1120, - "character": 45 + "character": 45, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1120" } ] } } }, { - "id": 1127, + "id": 1132, "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -23727,7 +28338,8 @@ { "fileName": "src/lib/types.ts", "line": 1107, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1107" } ], "type": { @@ -23736,14 +28348,14 @@ { "type": "reflection", "declaration": { - "id": 1128, + "id": 1133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1129, + "id": 1134, "name": "data", "kind": 1024, "kindString": "Property", @@ -23752,32 +28364,39 @@ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ], "type": { "type": "reflection", "declaration": { - "id": 1130, + "id": 1135, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1131, + "id": 1136, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully deleted." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully deleted." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1111" } ], "type": { @@ -23789,22 +28408,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1131] + "children": [1136] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1109, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1109" } ] } } }, { - "id": 1132, + "id": 1137, "name": "error", "kind": 1024, "kindString": "Property", @@ -23813,7 +28432,8 @@ { "fileName": "src/lib/types.ts", "line": 1113, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1113" } ], "type": { @@ -23825,15 +28445,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1129, 1132] + "children": [1134, 1137] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1108, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1108" } ] } @@ -23841,14 +28461,14 @@ { "type": "reflection", "declaration": { - "id": 1133, + "id": 1138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1134, + "id": 1139, "name": "data", "kind": 1024, "kindString": "Property", @@ -23857,7 +28477,8 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { @@ -23866,7 +28487,7 @@ } }, { - "id": 1135, + "id": 1140, "name": "error", "kind": 1024, "kindString": "Property", @@ -23875,12 +28496,13 @@ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -23888,15 +28510,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1134, 1135] + "children": [1139, 1140] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1115, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1115" } ] } @@ -23905,16 +28527,17 @@ } }, { - "id": 1149, + "id": 1154, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -23922,32 +28545,39 @@ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ], "type": { "type": "reflection", "declaration": { - "id": 1150, + "id": 1155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1151, + "id": 1156, "name": "userId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the user." + "summary": [ + { + "kind": "text", + "text": "ID of the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1146" } ], "type": { @@ -23959,31 +28589,32 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1151] + "children": [1156] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1144, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1144" } ] } } }, { - "id": 1140, + "id": 1145, "name": "AuthMFAAdminListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "expermental", - "text": "\n" + "tag": "@expermental", + "content": [] } ] }, @@ -23991,7 +28622,8 @@ { "fileName": "src/lib/types.ts", "line": 1131, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1131" } ], "type": { @@ -24000,14 +28632,14 @@ { "type": "reflection", "declaration": { - "id": 1141, + "id": 1146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1142, + "id": 1147, "name": "data", "kind": 1024, "kindString": "Property", @@ -24016,32 +28648,39 @@ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ], "type": { "type": "reflection", "declaration": { - "id": 1143, + "id": 1148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1144, + "id": 1149, "name": "factors", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All factors attached to the user." + "summary": [ + { + "kind": "text", + "text": "All factors attached to the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1135" } ], "type": { @@ -24057,22 +28696,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1144] + "children": [1149] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1133, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1133" } ] } } }, { - "id": 1145, + "id": 1150, "name": "error", "kind": 1024, "kindString": "Property", @@ -24081,7 +28720,8 @@ { "fileName": "src/lib/types.ts", "line": 1137, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1137" } ], "type": { @@ -24093,15 +28733,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1142, 1145] + "children": [1147, 1150] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1132, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1132" } ] } @@ -24109,14 +28749,14 @@ { "type": "reflection", "declaration": { - "id": 1146, + "id": 1151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1147, + "id": 1152, "name": "data", "kind": 1024, "kindString": "Property", @@ -24125,7 +28765,8 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { @@ -24134,7 +28775,7 @@ } }, { - "id": 1148, + "id": 1153, "name": "error", "kind": 1024, "kindString": "Property", @@ -24143,12 +28784,13 @@ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -24156,15 +28798,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1147, 1148] + "children": [1152, 1153] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1139, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1139" } ] } @@ -24173,7 +28815,7 @@ } }, { - "id": 1069, + "id": 1074, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -24182,7 +28824,8 @@ { "fileName": "src/lib/types.ts", "line": 977, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L977" } ], "type": { @@ -24191,14 +28834,14 @@ { "type": "reflection", "declaration": { - "id": 1070, + "id": 1075, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1071, + "id": 1076, "name": "data", "kind": 1024, "kindString": "Property", @@ -24207,32 +28850,39 @@ { "fileName": "src/lib/types.ts", "line": 979, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ], "type": { "type": "reflection", "declaration": { - "id": 1072, + "id": 1077, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1075, + "id": 1080, "name": "expires_at", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." + "summary": [ + { + "kind": "text", + "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 987, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L987" } ], "type": { @@ -24241,19 +28891,25 @@ } }, { - "id": 1073, + "id": 1078, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the newly created challenge." + "summary": [ + { + "kind": "text", + "text": "ID of the newly created challenge." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 981, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L981" } ], "type": { @@ -24262,19 +28918,25 @@ } }, { - "id": 1074, + "id": 1079, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Factor Type which generated the challenge" + "summary": [ + { + "kind": "text", + "text": "Factor Type which generated the challenge" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 984, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L984" } ], "type": { @@ -24295,22 +28957,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1075, 1073, 1074] + "children": [1080, 1078, 1079] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 979, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L979" } ] } } }, { - "id": 1076, + "id": 1081, "name": "error", "kind": 1024, "kindString": "Property", @@ -24319,7 +28981,8 @@ { "fileName": "src/lib/types.ts", "line": 989, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L989" } ], "type": { @@ -24331,15 +28994,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1071, 1076] + "children": [1076, 1081] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 978, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L978" } ] } @@ -24347,14 +29010,14 @@ { "type": "reflection", "declaration": { - "id": 1077, + "id": 1082, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1078, + "id": 1083, "name": "data", "kind": 1024, "kindString": "Property", @@ -24363,7 +29026,8 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { @@ -24372,7 +29036,7 @@ } }, { - "id": 1079, + "id": 1084, "name": "error", "kind": 1024, "kindString": "Property", @@ -24381,12 +29045,13 @@ { "fileName": "src/lib/types.ts", "line": 991, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -24394,15 +29059,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1078, 1079] + "children": [1083, 1084] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 991, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L991" } ] } @@ -24411,7 +29076,7 @@ } }, { - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -24420,7 +29085,8 @@ { "fileName": "src/lib/types.ts", "line": 1286, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1286" } ], "type": { @@ -24429,14 +29095,14 @@ { "type": "reflection", "declaration": { - "id": 1213, + "id": 1218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1214, + "id": 1219, "name": "data", "kind": 1024, "kindString": "Property", @@ -24445,20 +29111,21 @@ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ], "type": { "type": "reflection", "declaration": { - "id": 1215, + "id": 1220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1218, + "id": 1223, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -24466,13 +29133,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1296, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1296" } ], "type": { @@ -24481,19 +29154,25 @@ } }, { - "id": 1216, + "id": 1221, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1290, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1290" } ], "type": { @@ -24502,19 +29181,25 @@ } }, { - "id": 1219, + "id": 1224, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + "summary": [ + { + "kind": "text", + "text": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1299, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1299" } ], "type": { @@ -24523,19 +29208,25 @@ } }, { - "id": 1217, + "id": 1222, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1293, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1293" } ], "type": { @@ -24547,22 +29238,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1218, 1216, 1219, 1217] + "children": [1223, 1221, 1224, 1222] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ] } } }, { - "id": 1220, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -24571,7 +29262,8 @@ { "fileName": "src/lib/types.ts", "line": 1301, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1301" } ], "type": { @@ -24583,15 +29275,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1214, 1220] + "children": [1219, 1225] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1287" } ] } @@ -24599,14 +29291,14 @@ { "type": "reflection", "declaration": { - "id": 1221, + "id": 1226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1222, + "id": 1227, "name": "data", "kind": 1024, "kindString": "Property", @@ -24615,7 +29307,8 @@ { "fileName": "src/lib/types.ts", "line": 1304, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1304" } ], "type": { @@ -24624,7 +29317,7 @@ } }, { - "id": 1223, + "id": 1228, "name": "error", "kind": 1024, "kindString": "Property", @@ -24633,12 +29326,13 @@ { "fileName": "src/lib/types.ts", "line": 1305, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1305" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -24646,15 +29340,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1222, 1223] + "children": [1227, 1228] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1303, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1303" } ] } @@ -24663,7 +29357,7 @@ } }, { - "id": 1059, + "id": 1064, "name": "AuthMFAEnrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -24672,14 +29366,15 @@ { "fileName": "src/lib/types.ts", "line": 965, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L965" } ], "type": { "type": "union", "types": [ { - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -24688,7 +29383,8 @@ { "fileName": "src/lib/types.ts", "line": 1251, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1251" } ], "type": { @@ -24697,14 +29393,14 @@ { "type": "reflection", "declaration": { - "id": 1197, + "id": 1202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1198, + "id": 1203, "name": "data", "kind": 1024, "kindString": "Property", @@ -24713,20 +29409,21 @@ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ], "type": { "type": "reflection", "declaration": { - "id": 1199, + "id": 1204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1207, + "id": 1212, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -24734,13 +29431,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1277, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1277" } ], "type": { @@ -24749,19 +29452,25 @@ } }, { - "id": 1200, + "id": 1205, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1255, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1255" } ], "type": { @@ -24770,44 +29479,64 @@ } }, { - "id": 1202, + "id": 1207, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "TOTP enrollment information." + "summary": [ + { + "kind": "text", + "text": "TOTP enrollment information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ], "type": { "type": "reflection", "declaration": { - "id": 1203, + "id": 1208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1204, + "id": 1209, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending " + }, + { + "kind": "code", + "text": "`data:image/svg+xml;utf-8,`" + }, + { + "kind": "text", + "text": " to\nthe value. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1265, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1265" } ], "type": { @@ -24816,19 +29545,25 @@ } }, { - "id": 1205, + "id": 1210, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1270, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1270" } ], "type": { @@ -24837,19 +29572,25 @@ } }, { - "id": 1206, + "id": 1211, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + "summary": [ + { + "kind": "text", + "text": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1274, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1274" } ], "type": { @@ -24861,34 +29602,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1204, 1205, 1206] + "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ] } } }, { - "id": 1201, + "id": 1206, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1258, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1258" } ], "type": { @@ -24900,22 +29647,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1207, 1200, 1202, 1201] + "children": [1212, 1205, 1207, 1206] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ] } } }, { - "id": 1208, + "id": 1213, "name": "error", "kind": 1024, "kindString": "Property", @@ -24924,7 +29671,8 @@ { "fileName": "src/lib/types.ts", "line": 1279, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1279" } ], "type": { @@ -24936,15 +29684,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1198, 1208] + "children": [1203, 1213] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1252, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1252" } ] } @@ -24952,14 +29700,14 @@ { "type": "reflection", "declaration": { - "id": 1209, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1210, + "id": 1215, "name": "data", "kind": 1024, "kindString": "Property", @@ -24968,7 +29716,8 @@ { "fileName": "src/lib/types.ts", "line": 1282, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1282" } ], "type": { @@ -24977,7 +29726,7 @@ } }, { - "id": 1211, + "id": 1216, "name": "error", "kind": 1024, "kindString": "Property", @@ -24986,12 +29735,13 @@ { "fileName": "src/lib/types.ts", "line": 1283, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1283" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -24999,15 +29749,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1210, 1211] + "children": [1215, 1216] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1281, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1281" } ] } @@ -25016,7 +29766,7 @@ } }, { - "id": 1212, + "id": 1217, "name": "AuthMFAEnrollPhoneResponse", "kind": 4194304, "kindString": "Type alias", @@ -25025,7 +29775,8 @@ { "fileName": "src/lib/types.ts", "line": 1286, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1286" } ], "type": { @@ -25034,14 +29785,14 @@ { "type": "reflection", "declaration": { - "id": 1213, + "id": 1218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1214, + "id": 1219, "name": "data", "kind": 1024, "kindString": "Property", @@ -25050,20 +29801,21 @@ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ], "type": { "type": "reflection", "declaration": { - "id": 1215, + "id": 1220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1218, + "id": 1223, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -25071,13 +29823,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1296, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1296" } ], "type": { @@ -25086,19 +29844,25 @@ } }, { - "id": 1216, + "id": 1221, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1290, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1290" } ], "type": { @@ -25107,19 +29871,25 @@ } }, { - "id": 1219, + "id": 1224, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + "summary": [ + { + "kind": "text", + "text": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1299, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1299" } ], "type": { @@ -25128,19 +29898,25 @@ } }, { - "id": 1217, + "id": 1222, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1293, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1293" } ], "type": { @@ -25152,22 +29928,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1218, 1216, 1219, 1217] + "children": [1223, 1221, 1224, 1222] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1288, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1288" } ] } } }, { - "id": 1220, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -25176,7 +29952,8 @@ { "fileName": "src/lib/types.ts", "line": 1301, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1301" } ], "type": { @@ -25188,15 +29965,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1214, 1220] + "children": [1219, 1225] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1287" } ] } @@ -25204,14 +29981,14 @@ { "type": "reflection", "declaration": { - "id": 1221, + "id": 1226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1222, + "id": 1227, "name": "data", "kind": 1024, "kindString": "Property", @@ -25220,7 +29997,8 @@ { "fileName": "src/lib/types.ts", "line": 1304, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1304" } ], "type": { @@ -25229,7 +30007,7 @@ } }, { - "id": 1223, + "id": 1228, "name": "error", "kind": 1024, "kindString": "Property", @@ -25238,12 +30016,13 @@ { "fileName": "src/lib/types.ts", "line": 1305, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1305" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -25251,15 +30030,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1222, 1223] + "children": [1227, 1228] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1303, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1303" } ] } @@ -25271,7 +30050,7 @@ } }, { - "id": 1196, + "id": 1201, "name": "AuthMFAEnrollTOTPResponse", "kind": 4194304, "kindString": "Type alias", @@ -25280,7 +30059,8 @@ { "fileName": "src/lib/types.ts", "line": 1251, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1251" } ], "type": { @@ -25289,14 +30069,14 @@ { "type": "reflection", "declaration": { - "id": 1197, + "id": 1202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1198, + "id": 1203, "name": "data", "kind": 1024, "kindString": "Property", @@ -25305,20 +30085,21 @@ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ], "type": { "type": "reflection", "declaration": { - "id": 1199, + "id": 1204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1207, + "id": 1212, "name": "friendly_name", "kind": 1024, "kindString": "Property", @@ -25326,13 +30107,19 @@ "isOptional": true }, "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" + "summary": [ + { + "kind": "text", + "text": "Friendly name of the factor, useful for distinguishing between factors *" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1277, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1277" } ], "type": { @@ -25341,19 +30128,25 @@ } }, { - "id": 1200, + "id": 1205, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was just enrolled (in an unverified state)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1255, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1255" } ], "type": { @@ -25362,44 +30155,64 @@ } }, { - "id": 1202, + "id": 1207, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "TOTP enrollment information." + "summary": [ + { + "kind": "text", + "text": "TOTP enrollment information." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ], "type": { "type": "reflection", "declaration": { - "id": 1203, + "id": 1208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1204, + "id": 1209, "name": "qr_code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending " + }, + { + "kind": "code", + "text": "`data:image/svg+xml;utf-8,`" + }, + { + "kind": "text", + "text": " to\nthe value. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1265, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1265" } ], "type": { @@ -25408,19 +30221,25 @@ } }, { - "id": 1205, + "id": 1210, "name": "secret", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + "summary": [ + { + "kind": "text", + "text": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1270, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1270" } ], "type": { @@ -25429,19 +30248,25 @@ } }, { - "id": 1206, + "id": 1211, "name": "uri", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + "summary": [ + { + "kind": "text", + "text": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1274, - "character": 10 + "character": 10, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1274" } ], "type": { @@ -25453,34 +30278,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1204, 1205, 1206] + "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1261, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1261" } ] } } }, { - "id": 1201, + "id": 1206, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor." + "summary": [ + { + "kind": "text", + "text": "Type of MFA factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1258, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1258" } ], "type": { @@ -25492,22 +30323,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1207, 1200, 1202, 1201] + "children": [1212, 1205, 1207, 1206] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1253, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1253" } ] } } }, { - "id": 1208, + "id": 1213, "name": "error", "kind": 1024, "kindString": "Property", @@ -25516,7 +30347,8 @@ { "fileName": "src/lib/types.ts", "line": 1279, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1279" } ], "type": { @@ -25528,15 +30360,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1198, 1208] + "children": [1203, 1213] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1252, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1252" } ] } @@ -25544,14 +30376,14 @@ { "type": "reflection", "declaration": { - "id": 1209, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1210, + "id": 1215, "name": "data", "kind": 1024, "kindString": "Property", @@ -25560,7 +30392,8 @@ { "fileName": "src/lib/types.ts", "line": 1282, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1282" } ], "type": { @@ -25569,7 +30402,7 @@ } }, { - "id": 1211, + "id": 1216, "name": "error", "kind": 1024, "kindString": "Property", @@ -25578,12 +30411,13 @@ { "fileName": "src/lib/types.ts", "line": 1283, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1283" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -25591,15 +30425,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1210, 1211] + "children": [1215, 1216] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1281, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1281" } ] } @@ -25608,7 +30442,7 @@ } }, { - "id": 1092, + "id": 1097, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "kind": 4194304, "kindString": "Type alias", @@ -25617,7 +30451,8 @@ { "fileName": "src/lib/types.ts", "line": 1010, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1010" } ], "type": { @@ -25626,14 +30461,14 @@ { "type": "reflection", "declaration": { - "id": 1093, + "id": 1098, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1094, + "id": 1099, "name": "data", "kind": 1024, "kindString": "Property", @@ -25642,32 +30477,39 @@ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ], "type": { "type": "reflection", "declaration": { - "id": 1095, + "id": 1100, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1098, + "id": 1103, "name": "currentAuthenticationMethods", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + "summary": [ + { + "kind": "text", + "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1029, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1029" } ], "type": { @@ -25680,19 +30522,25 @@ } }, { - "id": 1096, + "id": 1101, "name": "currentLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Current AAL level of the session." + "summary": [ + { + "kind": "text", + "text": "Current AAL level of the session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1014, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1014" } ], "type": { @@ -25700,7 +30548,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -25711,17 +30559,29 @@ } }, { - "id": 1097, + "id": 1102, "name": "nextLevel", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." + } + ], + "blockTags": [ { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" + "tag": "@see", + "content": [ + { + "kind": "inline-tag", + "tag": "@link", + "text": "challenge", + "target": 1116 + } + ] } ] }, @@ -25729,7 +30589,8 @@ { "fileName": "src/lib/types.ts", "line": 1022, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1022" } ], "type": { @@ -25737,7 +30598,7 @@ "types": [ { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels" }, { @@ -25751,22 +30612,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1098, 1096, 1097] + "children": [1103, 1101, 1102] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1012, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1012" } ] } } }, { - "id": 1099, + "id": 1104, "name": "error", "kind": 1024, "kindString": "Property", @@ -25775,7 +30636,8 @@ { "fileName": "src/lib/types.ts", "line": 1031, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1031" } ], "type": { @@ -25787,15 +30649,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1094, 1099] + "children": [1099, 1104] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1011, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1011" } ] } @@ -25803,14 +30665,14 @@ { "type": "reflection", "declaration": { - "id": 1100, + "id": 1105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1101, + "id": 1106, "name": "data", "kind": 1024, "kindString": "Property", @@ -25819,7 +30681,8 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { @@ -25828,7 +30691,7 @@ } }, { - "id": 1102, + "id": 1107, "name": "error", "kind": 1024, "kindString": "Property", @@ -25837,12 +30700,13 @@ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -25850,15 +30714,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1101, 1102] + "children": [1106, 1107] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1033, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1033" } ] } @@ -25867,7 +30731,7 @@ } }, { - "id": 1080, + "id": 1085, "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", @@ -25876,7 +30740,8 @@ { "fileName": "src/lib/types.ts", "line": 993, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L993" } ], "type": { @@ -25885,14 +30750,14 @@ { "type": "reflection", "declaration": { - "id": 1081, + "id": 1086, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1082, + "id": 1087, "name": "data", "kind": 1024, "kindString": "Property", @@ -25901,32 +30766,39 @@ { "fileName": "src/lib/types.ts", "line": 995, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ], "type": { "type": "reflection", "declaration": { - "id": 1083, + "id": 1088, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1084, + "id": 1089, "name": "all", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "All available factors (verified and unverified)." + "summary": [ + { + "kind": "text", + "text": "All available factors (verified and unverified)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 997, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L997" } ], "type": { @@ -25939,19 +30811,33 @@ } }, { - "id": 1086, + "id": 1091, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified Phone factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified Phone factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1002, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1002" } ], "type": { @@ -25964,19 +30850,33 @@ } }, { - "id": 1085, + "id": 1090, "name": "totp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" + "summary": [ + { + "kind": "text", + "text": "Only verified TOTP factors. (A subset of " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": ".)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1000, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1000" } ], "type": { @@ -25992,22 +30892,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1084, 1086, 1085] + "children": [1089, 1091, 1090] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 995, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L995" } ] } } }, { - "id": 1087, + "id": 1092, "name": "error", "kind": 1024, "kindString": "Property", @@ -26016,7 +30916,8 @@ { "fileName": "src/lib/types.ts", "line": 1004, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1004" } ], "type": { @@ -26028,15 +30929,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1082, 1087] + "children": [1087, 1092] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 994, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L994" } ] } @@ -26044,14 +30945,14 @@ { "type": "reflection", "declaration": { - "id": 1088, + "id": 1093, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1089, + "id": 1094, "name": "data", "kind": 1024, "kindString": "Property", @@ -26060,7 +30961,8 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { @@ -26069,7 +30971,7 @@ } }, { - "id": 1090, + "id": 1095, "name": "error", "kind": 1024, "kindString": "Property", @@ -26078,12 +30980,13 @@ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -26091,15 +30994,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1089, 1090] + "children": [1094, 1095] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1006, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1006" } ] } @@ -26108,7 +31011,7 @@ } }, { - "id": 1060, + "id": 1065, "name": "AuthMFAUnenrollResponse", "kind": 4194304, "kindString": "Type alias", @@ -26117,7 +31020,8 @@ { "fileName": "src/lib/types.ts", "line": 967, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L967" } ], "type": { @@ -26126,14 +31030,14 @@ { "type": "reflection", "declaration": { - "id": 1061, + "id": 1066, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1062, + "id": 1067, "name": "data", "kind": 1024, "kindString": "Property", @@ -26142,32 +31046,39 @@ { "fileName": "src/lib/types.ts", "line": 969, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ], "type": { "type": "reflection", "declaration": { - "id": 1063, + "id": 1068, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1064, + "id": 1069, "name": "id", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor that was successfully unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor that was successfully unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 971, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L971" } ], "type": { @@ -26179,22 +31090,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1064] + "children": [1069] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 969, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L969" } ] } } }, { - "id": 1065, + "id": 1070, "name": "error", "kind": 1024, "kindString": "Property", @@ -26203,7 +31114,8 @@ { "fileName": "src/lib/types.ts", "line": 973, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L973" } ], "type": { @@ -26215,15 +31127,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1062, 1065] + "children": [1067, 1070] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 968, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L968" } ] } @@ -26231,14 +31143,14 @@ { "type": "reflection", "declaration": { - "id": 1066, + "id": 1071, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1067, + "id": 1072, "name": "data", "kind": 1024, "kindString": "Property", @@ -26247,7 +31159,8 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { @@ -26256,7 +31169,7 @@ } }, { - "id": 1068, + "id": 1073, "name": "error", "kind": 1024, "kindString": "Property", @@ -26265,12 +31178,13 @@ { "fileName": "src/lib/types.ts", "line": 975, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -26278,15 +31192,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1067, 1068] + "children": [1072, 1073] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 975, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L975" } ] } @@ -26295,7 +31209,7 @@ } }, { - "id": 1046, + "id": 1051, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -26304,7 +31218,8 @@ { "fileName": "src/lib/types.ts", "line": 940, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L940" } ], "type": { @@ -26313,14 +31228,14 @@ { "type": "reflection", "declaration": { - "id": 1047, + "id": 1052, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1048, + "id": 1053, "name": "data", "kind": 1024, "kindString": "Property", @@ -26329,32 +31244,39 @@ { "fileName": "src/lib/types.ts", "line": 942, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ], "type": { "type": "reflection", "declaration": { - "id": 1049, + "id": 1054, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1050, + "id": 1055, "name": "access_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "New access token (JWT) after successful verification." + "summary": [ + { + "kind": "text", + "text": "New access token (JWT) after successful verification." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 944, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L944" } ], "type": { @@ -26363,19 +31285,25 @@ } }, { - "id": 1052, + "id": 1057, "name": "expires_in", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Number of seconds in which the access token will expire." + "summary": [ + { + "kind": "text", + "text": "Number of seconds in which the access token will expire." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 950, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L950" } ], "type": { @@ -26384,19 +31312,25 @@ } }, { - "id": 1053, + "id": 1058, "name": "refresh_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." + "summary": [ + { + "kind": "text", + "text": "Refresh token you can use to obtain new access tokens when expired." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 953, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L953" } ], "type": { @@ -26405,19 +31339,33 @@ } }, { - "id": 1051, + "id": 1056, "name": "token_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of token, typically `Bearer`." + "summary": [ + { + "kind": "text", + "text": "Type of token, typically " + }, + { + "kind": "code", + "text": "`Bearer`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 947, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L947" } ], "type": { @@ -26426,19 +31374,25 @@ } }, { - "id": 1054, + "id": 1059, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Updated user profile." + "summary": [ + { + "kind": "text", + "text": "Updated user profile." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 956, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L956" } ], "type": { @@ -26451,22 +31405,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1050, 1052, 1053, 1051, 1054] + "children": [1055, 1057, 1058, 1056, 1059] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 942, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L942" } ] } } }, { - "id": 1055, + "id": 1060, "name": "error", "kind": 1024, "kindString": "Property", @@ -26475,7 +31429,8 @@ { "fileName": "src/lib/types.ts", "line": 958, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L958" } ], "type": { @@ -26487,15 +31442,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1048, 1055] + "children": [1053, 1060] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 941, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L941" } ] } @@ -26503,14 +31458,14 @@ { "type": "reflection", "declaration": { - "id": 1056, + "id": 1061, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1057, + "id": 1062, "name": "data", "kind": 1024, "kindString": "Property", @@ -26519,7 +31474,8 @@ { "fileName": "src/lib/types.ts", "line": 961, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L961" } ], "type": { @@ -26528,7 +31484,7 @@ } }, { - "id": 1058, + "id": 1063, "name": "error", "kind": 1024, "kindString": "Property", @@ -26537,12 +31493,13 @@ { "fileName": "src/lib/types.ts", "line": 962, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L962" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -26550,15 +31507,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1057, 1058] + "children": [1062, 1063] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 960, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L960" } ] } @@ -26573,14 +31530,24 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthResponse}\n" + "summary": [ + { + "kind": "text", + "text": "AuthOtpResponse is returned when OTP is used.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@see", + "text": "AuthResponse" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 146, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L146" } ], "type": { @@ -26605,7 +31572,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -26629,7 +31597,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -26656,7 +31625,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -26674,7 +31644,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ], "type": { @@ -26686,7 +31657,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [645, 644, 643] } ], @@ -26694,7 +31664,8 @@ { "fileName": "src/lib/types.ts", "line": 148, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L148" } ] } @@ -26710,7 +31681,8 @@ { "fileName": "src/lib/types.ts", "line": 149, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L149" } ], "type": { @@ -26722,7 +31694,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [641, 646] } ], @@ -26730,7 +31701,8 @@ { "fileName": "src/lib/types.ts", "line": 147, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L147" } ] } @@ -26754,7 +31726,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -26778,7 +31751,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -26805,7 +31779,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 26 + "character": 26, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -26823,7 +31798,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ], "type": { @@ -26835,7 +31811,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [652, 651, 650] } ], @@ -26843,7 +31818,8 @@ { "fileName": "src/lib/types.ts", "line": 152, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L152" } ] } @@ -26859,12 +31835,13 @@ { "fileName": "src/lib/types.ts", "line": 153, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L153" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -26872,7 +31849,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [648, 653] } ], @@ -26880,7 +31856,8 @@ { "fileName": "src/lib/types.ts", "line": 151, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L151" } ] } @@ -26898,7 +31875,8 @@ { "fileName": "src/lib/types.ts", "line": 108, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L108" } ], "type": { @@ -26923,7 +31901,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ], "type": { @@ -26945,7 +31924,8 @@ { "fileName": "src/lib/types.ts", "line": 112, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L112" } ], "type": { @@ -26973,7 +31953,8 @@ { "fileName": "src/lib/types.ts", "line": 111, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L111" } ], "type": { @@ -26995,7 +31976,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [617, 616] } ], @@ -27003,7 +31983,8 @@ { "fileName": "src/lib/types.ts", "line": 110, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L110" } ] } @@ -27019,7 +32000,8 @@ { "fileName": "src/lib/types.ts", "line": 114, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L114" } ], "type": { @@ -27031,7 +32013,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [614, 618] } ], @@ -27039,7 +32020,8 @@ { "fileName": "src/lib/types.ts", "line": 109, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L109" } ] } @@ -27063,7 +32045,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ], "type": { @@ -27085,7 +32068,8 @@ { "fileName": "src/lib/types.ts", "line": 119, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L119" } ], "type": { @@ -27103,7 +32087,8 @@ { "fileName": "src/lib/types.ts", "line": 118, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L118" } ], "type": { @@ -27115,7 +32100,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [623, 622] } ], @@ -27123,7 +32107,8 @@ { "fileName": "src/lib/types.ts", "line": 117, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L117" } ] } @@ -27139,12 +32124,13 @@ { "fileName": "src/lib/types.ts", "line": 121, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L121" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -27152,7 +32138,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [620, 624] } ], @@ -27160,7 +32145,8 @@ { "fileName": "src/lib/types.ts", "line": 116, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L116" } ] } @@ -27178,7 +32164,8 @@ { "fileName": "src/lib/types.ts", "line": 124, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L124" } ], "type": { @@ -27203,7 +32190,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ], "type": { @@ -27225,7 +32213,8 @@ { "fileName": "src/lib/types.ts", "line": 128, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L128" } ], "type": { @@ -27253,7 +32242,8 @@ { "fileName": "src/lib/types.ts", "line": 127, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L127" } ], "type": { @@ -27283,7 +32273,8 @@ { "fileName": "src/lib/types.ts", "line": 129, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L129" } ], "type": { @@ -27305,7 +32296,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [630, 629, 631] } ], @@ -27313,7 +32303,8 @@ { "fileName": "src/lib/types.ts", "line": 126, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L126" } ] } @@ -27329,7 +32320,8 @@ { "fileName": "src/lib/types.ts", "line": 131, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L131" } ], "type": { @@ -27341,7 +32333,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [627, 632] } ], @@ -27349,7 +32340,8 @@ { "fileName": "src/lib/types.ts", "line": 125, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L125" } ] } @@ -27373,7 +32365,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ], "type": { @@ -27395,7 +32388,8 @@ { "fileName": "src/lib/types.ts", "line": 136, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L136" } ], "type": { @@ -27413,7 +32407,8 @@ { "fileName": "src/lib/types.ts", "line": 135, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L135" } ], "type": { @@ -27425,7 +32420,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [637, 636] } ], @@ -27433,7 +32427,8 @@ { "fileName": "src/lib/types.ts", "line": 134, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L134" } ] } @@ -27449,12 +32444,13 @@ { "fileName": "src/lib/types.ts", "line": 138, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L138" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -27462,7 +32458,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [634, 638] } ], @@ -27470,7 +32465,8 @@ { "fileName": "src/lib/types.ts", "line": 133, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L133" } ] } @@ -27488,7 +32484,8 @@ { "fileName": "src/lib/types.ts", "line": 156, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L156" } ], "type": { @@ -27513,7 +32510,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ], "type": { @@ -27535,7 +32533,8 @@ { "fileName": "src/lib/types.ts", "line": 160, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L160" } ], "type": { @@ -27554,7 +32553,8 @@ { "fileName": "src/lib/types.ts", "line": 159, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L159" } ], "type": { @@ -27567,7 +32567,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [659, 658] } ], @@ -27575,7 +32574,8 @@ { "fileName": "src/lib/types.ts", "line": 158, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L158" } ] } @@ -27591,7 +32591,8 @@ { "fileName": "src/lib/types.ts", "line": 162, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L162" } ], "type": { @@ -27603,7 +32604,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [656, 660] } ], @@ -27611,7 +32611,8 @@ { "fileName": "src/lib/types.ts", "line": 157, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L157" } ] } @@ -27635,7 +32636,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ], "type": { @@ -27657,7 +32659,8 @@ { "fileName": "src/lib/types.ts", "line": 167, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L167" } ], "type": { @@ -27675,7 +32678,8 @@ { "fileName": "src/lib/types.ts", "line": 166, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L166" } ], "type": { @@ -27687,7 +32691,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [665, 664] } ], @@ -27695,7 +32698,8 @@ { "fileName": "src/lib/types.ts", "line": 165, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L165" } ] } @@ -27711,12 +32715,13 @@ { "fileName": "src/lib/types.ts", "line": 169, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L169" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -27724,7 +32729,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [662, 666] } ], @@ -27732,7 +32736,8 @@ { "fileName": "src/lib/types.ts", "line": 164, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L164" } ] } @@ -27750,7 +32755,8 @@ { "fileName": "src/lib/types.ts", "line": 172, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L172" } ], "type": { @@ -27775,7 +32781,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ], "type": { @@ -27797,7 +32804,8 @@ { "fileName": "src/lib/types.ts", "line": 176, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L176" } ], "type": { @@ -27816,7 +32824,8 @@ { "fileName": "src/lib/types.ts", "line": 175, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L175" } ], "type": { @@ -27837,7 +32846,8 @@ { "fileName": "src/lib/types.ts", "line": 177, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L177" } ], "type": { @@ -27850,7 +32860,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [672, 671, 673] } ], @@ -27858,7 +32867,8 @@ { "fileName": "src/lib/types.ts", "line": 174, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L174" } ] } @@ -27874,7 +32884,8 @@ { "fileName": "src/lib/types.ts", "line": 179, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L179" } ], "type": { @@ -27886,7 +32897,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [669, 674] } ], @@ -27894,7 +32904,8 @@ { "fileName": "src/lib/types.ts", "line": 173, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L173" } ] } @@ -27918,7 +32929,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ], "type": { @@ -27940,7 +32952,8 @@ { "fileName": "src/lib/types.ts", "line": 184, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L184" } ], "type": { @@ -27958,7 +32971,8 @@ { "fileName": "src/lib/types.ts", "line": 183, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L183" } ], "type": { @@ -27978,7 +32992,8 @@ { "fileName": "src/lib/types.ts", "line": 185, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L185" } ], "type": { @@ -27990,7 +33005,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [679, 678, 680] } ], @@ -27998,7 +33012,8 @@ { "fileName": "src/lib/types.ts", "line": 182, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L182" } ] } @@ -28014,12 +33029,13 @@ { "fileName": "src/lib/types.ts", "line": 187, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L187" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -28027,7 +33043,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [676, 681] } ], @@ -28035,7 +33050,8 @@ { "fileName": "src/lib/types.ts", "line": 181, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L181" } ] } @@ -28044,7 +33060,7 @@ } }, { - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -28053,7 +33069,8 @@ { "fileName": "src/lib/types.ts", "line": 1008, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1008" } ], "type": { @@ -28071,7 +33088,7 @@ } }, { - "id": 1165, + "id": 1170, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -28080,7 +33097,8 @@ { "fileName": "src/lib/types.ts", "line": 1196, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1196" } ], "type": { @@ -28089,14 +33107,14 @@ { "type": "reflection", "declaration": { - "id": 1166, + "id": 1171, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1168, + "id": 1173, "name": "error", "kind": 1024, "kindString": "Property", @@ -28105,7 +33123,8 @@ { "fileName": "src/lib/types.ts", "line": 1199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1199" } ], "type": { @@ -28114,7 +33133,7 @@ } }, { - "id": 1167, + "id": 1172, "name": "session", "kind": 1024, "kindString": "Property", @@ -28123,7 +33142,8 @@ { "fileName": "src/lib/types.ts", "line": 1198, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1198" } ], "type": { @@ -28136,15 +33156,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1168, 1167] + "children": [1173, 1172] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1197, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1197" } ] } @@ -28152,14 +33172,14 @@ { "type": "reflection", "declaration": { - "id": 1169, + "id": 1174, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1171, + "id": 1176, "name": "error", "kind": 1024, "kindString": "Property", @@ -28168,17 +33188,18 @@ { "fileName": "src/lib/types.ts", "line": 1203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } }, { - "id": 1170, + "id": 1175, "name": "session", "kind": 1024, "kindString": "Property", @@ -28187,7 +33208,8 @@ { "fileName": "src/lib/types.ts", "line": 1202, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1202" } ], "type": { @@ -28199,15 +33221,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1171, 1170] + "children": [1176, 1175] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1201, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1201" } ] } @@ -28216,7 +33238,7 @@ } }, { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -28225,7 +33247,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -28259,7 +33282,7 @@ } }, { - "id": 914, + "id": 919, "name": "EthereumWallet", "kind": 4194304, "kindString": "Type alias", @@ -28268,7 +33291,8 @@ { "fileName": "src/lib/types.ts", "line": 678, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L678" } ], "type": { @@ -28277,7 +33301,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -28286,7 +33310,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -28295,14 +33320,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -28311,7 +33336,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -28320,7 +33346,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -28331,20 +33357,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28352,13 +33379,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -28367,7 +33400,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -28378,7 +33411,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -28413,18 +33447,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -28432,13 +33466,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -28450,22 +33490,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -28473,13 +33513,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -28488,7 +33534,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -28496,18 +33542,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -28515,15 +33575,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -28531,14 +33591,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -28547,7 +33607,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -28556,19 +33617,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -28577,7 +33668,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -28588,20 +33679,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28609,13 +33701,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -28627,34 +33725,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -28666,15 +33770,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -28683,7 +33787,7 @@ } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -28692,32 +33796,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -28726,19 +33837,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -28747,7 +33864,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -28758,7 +33875,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -28766,7 +33884,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -28774,13 +33892,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -28789,7 +33907,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -28810,22 +33929,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -28834,32 +33953,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -28868,7 +33994,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -28879,7 +34005,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -28887,7 +34014,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -28904,13 +34031,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -28919,7 +34046,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -28940,22 +34068,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 1007, + "id": 1012, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -28964,14 +34092,15 @@ { "fileName": "src/lib/types.ts", "line": 856, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L856" } ], "type": { "type": "union", "types": [ { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -28980,20 +34109,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -29002,7 +34132,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -29011,7 +34142,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -29022,7 +34153,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -29030,7 +34162,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -29047,13 +34179,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -29062,7 +34194,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -29071,7 +34204,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -29080,7 +34213,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -29092,22 +34226,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } } }, { - "id": 988, + "id": 993, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -29116,32 +34250,39 @@ { "fileName": "src/lib/types.ts", "line": 820, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ], "type": { "type": "reflection", "declaration": { - "id": 989, + "id": 994, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 991, + "id": 996, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 823, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L823" } ], "type": { @@ -29150,7 +34291,7 @@ } }, { - "id": 992, + "id": 997, "name": "options", "kind": 1024, "kindString": "Property", @@ -29161,7 +34302,8 @@ { "fileName": "src/lib/types.ts", "line": 824, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L824" } ], "type": { @@ -29169,7 +34311,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -29186,13 +34328,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 990, + "id": 995, "name": "type", "kind": 1024, "kindString": "Property", @@ -29201,7 +34343,8 @@ { "fileName": "src/lib/types.ts", "line": 821, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L821" } ], "type": { @@ -29222,22 +34365,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [991, 992, 990] + "children": [996, 997, 995] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 820, - "character": 46 + "character": 46, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L820" } ] } } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -29246,32 +34389,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -29280,7 +34430,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -29291,7 +34441,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -29299,7 +34450,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -29307,13 +34458,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -29322,7 +34473,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -29334,22 +34486,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 998, + "id": 1003, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -29358,32 +34510,39 @@ { "fileName": "src/lib/types.ts", "line": 834, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ], "type": { "type": "reflection", "declaration": { - "id": 999, + "id": 1004, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1001, + "id": 1006, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 837, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L837" } ], "type": { @@ -29392,19 +34551,25 @@ } }, { - "id": 1002, + "id": 1007, "name": "newEmail", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + "summary": [ + { + "kind": "text", + "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 841, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L841" } ], "type": { @@ -29413,7 +34578,7 @@ } }, { - "id": 1003, + "id": 1008, "name": "options", "kind": 1024, "kindString": "Property", @@ -29424,7 +34589,8 @@ { "fileName": "src/lib/types.ts", "line": 842, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L842" } ], "type": { @@ -29432,7 +34598,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -29440,13 +34606,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 1000, + "id": 1005, "name": "type", "kind": 1024, "kindString": "Property", @@ -29455,7 +34621,8 @@ { "fileName": "src/lib/types.ts", "line": 835, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L835" } ], "type": { @@ -29476,15 +34643,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1001, 1002, 1003, 1000] + "children": [1006, 1007, 1008, 1005] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 834, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L834" } ] } @@ -29494,44 +34661,56 @@ } }, { - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "The properties related to the email link generated" + "summary": [ + { + "kind": "text", + "text": "The properties related to the email link generated" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ], "type": { "type": "reflection", "declaration": { - "id": 1022, + "id": 1027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1023, + "id": 1028, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + "summary": [ + { + "kind": "text", + "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 884, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L884" } ], "type": { @@ -29540,19 +34719,25 @@ } }, { - "id": 1024, + "id": 1029, "name": "email_otp", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + "summary": [ + { + "kind": "text", + "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 889, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L889" } ], "type": { @@ -29561,19 +34746,25 @@ } }, { - "id": 1025, + "id": 1030, "name": "hashed_token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The hashed token appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The hashed token appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 893, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L893" } ], "type": { @@ -29582,19 +34773,25 @@ } }, { - "id": 1026, + "id": 1031, "name": "redirect_to", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The URL appended to the action link." + "summary": [ + { + "kind": "text", + "text": "The URL appended to the action link." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 895, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L895" } ], "type": { @@ -29603,27 +34800,33 @@ } }, { - "id": 1027, + "id": 1032, "name": "verification_type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The verification type that the email link is associated to." + "summary": [ + { + "kind": "text", + "text": "The verification type that the email link is associated to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 897, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L897" } ], "type": { "type": "reference", - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "dereferenced": { - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -29632,7 +34835,8 @@ { "fileName": "src/lib/types.ts", "line": 900, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L900" } ], "type": { @@ -29671,22 +34875,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1023, 1024, 1025, 1026, 1027] + "children": [1028, 1029, 1030, 1031, 1032] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 879, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L879" } ] } } }, { - "id": 1008, + "id": 1013, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -29695,7 +34899,8 @@ { "fileName": "src/lib/types.ts", "line": 862, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L862" } ], "type": { @@ -29704,14 +34909,14 @@ { "type": "reflection", "declaration": { - "id": 1009, + "id": 1014, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1010, + "id": 1015, "name": "data", "kind": 1024, "kindString": "Property", @@ -29720,20 +34925,21 @@ { "fileName": "src/lib/types.ts", "line": 864, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ], "type": { "type": "reflection", "declaration": { - "id": 1011, + "id": 1016, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1012, + "id": 1017, "name": "properties", "kind": 1024, "kindString": "Property", @@ -29742,17 +34948,18 @@ { "fileName": "src/lib/types.ts", "line": 865, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L865" } ], "type": { "type": "reference", - "id": 1021, + "id": 1026, "name": "GenerateLinkProperties" } }, { - "id": 1013, + "id": 1018, "name": "user", "kind": 1024, "kindString": "Property", @@ -29761,7 +34968,8 @@ { "fileName": "src/lib/types.ts", "line": 866, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L866" } ], "type": { @@ -29774,22 +34982,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1012, 1013] + "children": [1017, 1018] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 864, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L864" } ] } } }, { - "id": 1014, + "id": 1019, "name": "error", "kind": 1024, "kindString": "Property", @@ -29798,7 +35006,8 @@ { "fileName": "src/lib/types.ts", "line": 868, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L868" } ], "type": { @@ -29810,15 +35019,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1010, 1014] + "children": [1015, 1019] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 863, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L863" } ] } @@ -29826,14 +35035,14 @@ { "type": "reflection", "declaration": { - "id": 1015, + "id": 1020, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1016, + "id": 1021, "name": "data", "kind": 1024, "kindString": "Property", @@ -29842,20 +35051,21 @@ { "fileName": "src/lib/types.ts", "line": 871, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ], "type": { "type": "reflection", "declaration": { - "id": 1017, + "id": 1022, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1018, + "id": 1023, "name": "properties", "kind": 1024, "kindString": "Property", @@ -29864,7 +35074,8 @@ { "fileName": "src/lib/types.ts", "line": 872, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L872" } ], "type": { @@ -29873,7 +35084,7 @@ } }, { - "id": 1019, + "id": 1024, "name": "user", "kind": 1024, "kindString": "Property", @@ -29882,7 +35093,8 @@ { "fileName": "src/lib/types.ts", "line": 873, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L873" } ], "type": { @@ -29894,22 +35106,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1018, 1019] + "children": [1023, 1024] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 871, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L871" } ] } } }, { - "id": 1020, + "id": 1025, "name": "error", "kind": 1024, "kindString": "Property", @@ -29918,12 +35130,13 @@ { "fileName": "src/lib/types.ts", "line": 875, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L875" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -29931,15 +35144,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1016, 1020] + "children": [1021, 1025] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 870, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L870" } ] } @@ -29948,7 +35161,7 @@ } }, { - "id": 1028, + "id": 1033, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -29957,7 +35170,8 @@ { "fileName": "src/lib/types.ts", "line": 900, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L900" } ], "type": { @@ -29991,7 +35205,7 @@ } }, { - "id": 993, + "id": 998, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -30000,32 +35214,39 @@ { "fileName": "src/lib/types.ts", "line": 827, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ], "type": { "type": "reflection", "declaration": { - "id": 994, + "id": 999, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 996, + "id": 1001, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email" + "summary": [ + { + "kind": "text", + "text": "The user's email" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 830, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L830" } ], "type": { @@ -30034,7 +35255,7 @@ } }, { - "id": 997, + "id": 1002, "name": "options", "kind": 1024, "kindString": "Property", @@ -30045,7 +35266,8 @@ { "fileName": "src/lib/types.ts", "line": 831, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L831" } ], "type": { @@ -30053,7 +35275,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -30061,13 +35283,13 @@ "value": "redirectTo" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 995, + "id": 1000, "name": "type", "kind": 1024, "kindString": "Property", @@ -30076,7 +35298,8 @@ { "fileName": "src/lib/types.ts", "line": 828, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L828" } ], "type": { @@ -30088,22 +35311,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [996, 997, 995] + "children": [1001, 1002, 1000] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 827, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L827" } ] } } }, { - "id": 982, + "id": 987, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -30112,20 +35335,21 @@ { "fileName": "src/lib/types.ts", "line": 813, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ], "type": { "type": "reflection", "declaration": { - "id": 983, + "id": 988, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 985, + "id": 990, "name": "email", "kind": 1024, "kindString": "Property", @@ -30134,7 +35358,8 @@ { "fileName": "src/lib/types.ts", "line": 815, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L815" } ], "type": { @@ -30143,7 +35368,7 @@ } }, { - "id": 987, + "id": 992, "name": "options", "kind": 1024, "kindString": "Property", @@ -30154,7 +35379,8 @@ { "fileName": "src/lib/types.ts", "line": 817, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L817" } ], "type": { @@ -30162,7 +35388,7 @@ "typeArguments": [ { "type": "reference", - "id": 1004, + "id": 1009, "name": "GenerateLinkOptions" }, { @@ -30179,13 +35405,13 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 986, + "id": 991, "name": "password", "kind": 1024, "kindString": "Property", @@ -30194,7 +35420,8 @@ { "fileName": "src/lib/types.ts", "line": 816, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L816" } ], "type": { @@ -30203,7 +35430,7 @@ } }, { - "id": 984, + "id": 989, "name": "type", "kind": 1024, "kindString": "Property", @@ -30212,7 +35439,8 @@ { "fileName": "src/lib/types.ts", "line": 814, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L814" } ], "type": { @@ -30224,15 +35452,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [985, 987, 986, 984] + "children": [990, 992, 991, 989] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 813, - "character": 39 + "character": 39, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L813" } ] } @@ -30248,7 +35476,8 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ], "type": { @@ -30272,7 +35501,8 @@ { "fileName": "src/lib/types.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L70" } ], "type": { @@ -30292,7 +35522,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "type": { @@ -30314,7 +35545,8 @@ { "fileName": "src/lib/types.ts", "line": 88, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L88" } ], "signatures": [ @@ -30376,7 +35608,8 @@ { "fileName": "src/lib/types.ts", "line": 68, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L68" } ], "type": { @@ -30396,7 +35629,8 @@ { "fileName": "src/lib/types.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L84" } ], "type": { @@ -30416,15 +35650,16 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L86" } ], "type": { "type": "reference", - "id": 861, + "id": 863, "name": "AuthFlowType", "dereferenced": { - "id": 861, + "id": 863, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -30433,7 +35668,8 @@ { "fileName": "src/lib/types.ts", "line": 601, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L601" } ], "type": { @@ -30461,19 +35697,20 @@ "isOptional": true }, "comment": { - "shortText": "Set to \"true\" if there is a custom authorization header set globally.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Set to \"true\" if there is a custom authorization header set globally." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L99" } ], "type": { @@ -30493,7 +35730,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "type": { @@ -30508,7 +35746,8 @@ { "fileName": "src/lib/types.ts", "line": 64, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L64" } ], "indexSignature": { @@ -30546,19 +35785,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 94, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L94" } ], "type": { @@ -30575,7 +35815,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -30590,7 +35831,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -30601,13 +35843,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -30626,7 +35876,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -30640,7 +35895,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -30654,7 +35922,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -30668,7 +35941,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -30687,9 +35961,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -30706,9 +35980,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -30729,7 +36003,8 @@ { "fileName": "src/lib/types.ts", "line": 72, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L72" } ], "type": { @@ -30749,15 +36024,16 @@ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L74" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -30766,7 +36042,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -30780,9 +36057,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -30802,9 +36079,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -30812,14 +36089,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -30827,13 +36104,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -30845,15 +36136,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -30875,7 +36166,8 @@ { "fileName": "src/lib/types.ts", "line": 66, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L66" } ], "type": { @@ -30895,7 +36187,8 @@ { "fileName": "src/lib/types.ts", "line": 62, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L62" } ], "type": { @@ -30912,28 +36205,68 @@ "isOptional": true }, "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, `storage` will only store a JSON object containing the access and refresh token and some adjacent metadata, while `userStorage` will only contain the user object under the key `storageKey + '-user'`.", - "text": "When this option is set and cookie storage is used, `getSession()` and other functions that load a session from the cookie store might not return back a user. It's very important to always use `getUser()` to fetch a user object in those scenarios.\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " + }, + { + "kind": "code", + "text": "`storage`" + }, { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " + }, + { + "kind": "code", + "text": "`userStorage`" + }, + { + "kind": "text", + "text": " will only contain the user object under the key " + }, + { + "kind": "code", + "text": "`storageKey + '-user'`" + }, + { + "kind": "text", + "text": ".\n\nWhen this option is set and cookie storage is used, " + }, + { + "kind": "code", + "text": "`getSession()`" + }, + { + "kind": "text", + "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " + }, + { + "kind": "code", + "text": "`getUser()`" + }, + { + "kind": "text", + "text": " to fetch a user object in those scenarios." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 82, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L82" } ], "type": { "type": "reference", - "id": 1159, + "id": 1164, "name": "SupportedStorage", "dereferenced": { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -30942,7 +36275,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -30956,9 +36290,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -30978,9 +36312,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -30988,14 +36322,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -31003,13 +36337,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -31021,15 +36369,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -31043,7 +36391,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [593, 599, 592, 597, 598, 605, 587, 604, 594, 595, 591, 586, 596] } ], @@ -31051,14 +36398,15 @@ { "fileName": "src/lib/types.ts", "line": 60, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L60" } ] } } }, { - "id": 1162, + "id": 1167, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -31067,20 +36415,21 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { "type": "reflection", "declaration": { - "id": 1163, + "id": 1168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1164, + "id": 1169, "name": "error", "kind": 1024, "kindString": "Property", @@ -31089,7 +36438,8 @@ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ], "type": { @@ -31097,7 +36447,7 @@ "types": [ { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" }, { @@ -31111,22 +36461,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1164] + "children": [1169] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1194, - "character": 31 + "character": 31, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1194" } ] } } }, { - "id": 1224, + "id": 1229, "name": "JwtHeader", "kind": 4194304, "kindString": "Type alias", @@ -31135,20 +36485,21 @@ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ], "type": { "type": "reflection", "declaration": { - "id": 1225, + "id": 1230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1226, + "id": 1231, "name": "alg", "kind": 1024, "kindString": "Property", @@ -31157,7 +36508,8 @@ { "fileName": "src/lib/types.ts", "line": 1309, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1309" } ], "type": { @@ -31179,7 +36531,7 @@ } }, { - "id": 1227, + "id": 1232, "name": "kid", "kind": 1024, "kindString": "Property", @@ -31188,7 +36540,8 @@ { "fileName": "src/lib/types.ts", "line": 1310, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1310" } ], "type": { @@ -31197,7 +36550,7 @@ } }, { - "id": 1228, + "id": 1233, "name": "typ", "kind": 1024, "kindString": "Property", @@ -31206,7 +36559,8 @@ { "fileName": "src/lib/types.ts", "line": 1311, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1311" } ], "type": { @@ -31218,22 +36572,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1226, 1227, 1228] + "children": [1231, 1232, 1233] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1308, - "character": 24 + "character": 24, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1308" } ] } } }, { - "id": 1239, + "id": 1244, "name": "JwtPayload", "kind": 4194304, "kindString": "Type alias", @@ -31242,7 +36596,8 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "type": { @@ -31250,13 +36605,13 @@ "types": [ { "type": "reference", - "id": 1229, + "id": 1234, "name": "RequiredClaims" }, { "type": "reflection", "declaration": { - "id": 1240, + "id": 1245, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -31265,18 +36620,19 @@ { "fileName": "src/lib/types.ts", "line": 1325, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1325" } ], "indexSignature": { - "id": 1241, + "id": 1246, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1242, + "id": 1247, "name": "key", "kind": 32768, "flags": {}, @@ -31306,7 +36662,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "type": { @@ -31321,7 +36678,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 23 + "character": 23, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -31332,13 +36690,21 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" + }, { - "tag": "experimental", - "text": "\n" + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": " async function, such that no other client instances will be able to\nhold it at the same time." } - ] + ], + "modifierTags": ["@experimental"] }, "typeParameter": [ { @@ -31357,7 +36723,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -31371,7 +36742,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." + } + ] }, "type": { "type": "intrinsic", @@ -31385,7 +36769,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to execute when the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to execute when the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -31399,7 +36788,8 @@ { "fileName": "src/lib/types.ts", "line": 58, - "character": 69 + "character": 69, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L58" } ], "signatures": [ @@ -31418,9 +36808,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -31437,9 +36827,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -31447,7 +36837,7 @@ } }, { - "id": 1042, + "id": 1047, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -31456,32 +36846,39 @@ { "fileName": "src/lib/types.ts", "line": 933, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 1043, + "id": 1048, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1050, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 937, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L937" } ], "type": { @@ -31490,19 +36887,25 @@ } }, { - "id": 1044, + "id": 1049, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 935, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L935" } ], "type": { @@ -31514,22 +36917,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1045, 1044] + "children": [1050, 1049] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 933, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L933" } ] } } }, { - "id": 1038, + "id": 1043, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -31538,20 +36941,21 @@ { "fileName": "src/lib/types.ts", "line": 926, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ], "type": { "type": "reflection", "declaration": { - "id": 1039, + "id": 1044, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1046, "name": "channel", "kind": 1024, "kindString": "Property", @@ -31559,13 +36963,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 930, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L930" } ], "type": { @@ -31583,19 +36993,25 @@ } }, { - "id": 1040, + "id": 1045, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor to be challenged. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 928, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L928" } ], "type": { @@ -31607,22 +37023,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1041, 1040] + "children": [1046, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 926, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L926" } ] } } }, { - "id": 1029, + "id": 1034, "name": "MFAEnrollParams", "kind": 4194304, "kindString": "Type alias", @@ -31631,14 +37047,15 @@ { "fileName": "src/lib/types.ts", "line": 908, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L908" } ], "type": { "type": "union", "types": [ { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -31647,32 +37064,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -31681,7 +37105,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -31689,13 +37113,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -31704,7 +37134,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -31712,13 +37142,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -31730,22 +37166,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -31754,32 +37190,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -31788,7 +37231,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -31796,13 +37239,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -31811,19 +37260,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -31835,15 +37290,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } @@ -31853,7 +37308,7 @@ } }, { - "id": 1191, + "id": 1196, "name": "MFAEnrollPhoneParams", "kind": 4194304, "kindString": "Type alias", @@ -31862,32 +37317,39 @@ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ], "type": { "type": "reflection", "declaration": { - "id": 1192, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1193, + "id": 1198, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1244, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1244" } ], "type": { @@ -31896,7 +37358,7 @@ } }, { - "id": 1194, + "id": 1199, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -31904,13 +37366,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1246, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1246" } ], "type": { @@ -31919,19 +37387,25 @@ } }, { - "id": 1195, + "id": 1200, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + "summary": [ + { + "kind": "text", + "text": "Phone number associated with a factor. Number should conform to E.164 format" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1248, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1248" } ], "type": { @@ -31943,22 +37417,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1193, 1194, 1195] + "children": [1198, 1199, 1200] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1242, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1242" } ] } } }, { - "id": 1186, + "id": 1191, "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", @@ -31967,32 +37441,39 @@ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ], "type": { "type": "reflection", "declaration": { - "id": 1187, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1188, + "id": 1193, "name": "factorType", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The type of factor being enrolled." + "summary": [ + { + "kind": "text", + "text": "The type of factor being enrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1236, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1236" } ], "type": { @@ -32001,7 +37482,7 @@ } }, { - "id": 1190, + "id": 1195, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -32009,13 +37490,19 @@ "isOptional": true }, "comment": { - "shortText": "Human readable name assigned to the factor." + "summary": [ + { + "kind": "text", + "text": "Human readable name assigned to the factor." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1240, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1240" } ], "type": { @@ -32024,7 +37511,7 @@ } }, { - "id": 1189, + "id": 1194, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -32032,13 +37519,19 @@ "isOptional": true }, "comment": { - "shortText": "Domain which the user is enrolled with." + "summary": [ + { + "kind": "text", + "text": "Domain which the user is enrolled with." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1238, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1238" } ], "type": { @@ -32050,22 +37543,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1188, 1190, 1189] + "children": [1193, 1195, 1194] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1234, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1234" } ] } } }, { - "id": 1030, + "id": 1035, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -32074,32 +37567,39 @@ { "fileName": "src/lib/types.ts", "line": 910, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ], "type": { "type": "reflection", "declaration": { - "id": 1031, + "id": 1036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1032, + "id": 1037, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being unenrolled." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being unenrolled." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 912, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L912" } ], "type": { @@ -32111,22 +37611,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1032] + "children": [1037] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 910, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L910" } ] } } }, { - "id": 1033, + "id": 1038, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -32135,32 +37635,39 @@ { "fileName": "src/lib/types.ts", "line": 915, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ], "type": { "type": "reflection", "declaration": { - "id": 1034, + "id": 1039, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1036, + "id": 1041, "name": "challengeId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." + "summary": [ + { + "kind": "text", + "text": "ID of the challenge being verified. Returned in challenge()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 920, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L920" } ], "type": { @@ -32169,19 +37676,25 @@ } }, { - "id": 1037, + "id": 1042, "name": "code", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Verification code provided by the user." + "summary": [ + { + "kind": "text", + "text": "Verification code provided by the user." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 923, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L923" } ], "type": { @@ -32190,19 +37703,25 @@ } }, { - "id": 1035, + "id": 1040, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." + "summary": [ + { + "kind": "text", + "text": "ID of the factor being verified. Returned in enroll()." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 917, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L917" } ], "type": { @@ -32214,22 +37733,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1036, 1037, 1035] + "children": [1041, 1042, 1040] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 915, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L915" } ] } } }, { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -32238,7 +37757,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -32265,7 +37785,8 @@ { "fileName": "src/lib/types.ts", "line": 190, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L190" } ], "type": { @@ -32290,7 +37811,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ], "type": { @@ -32312,7 +37834,8 @@ { "fileName": "src/lib/types.ts", "line": 193, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L193" } ], "type": { @@ -32331,7 +37854,8 @@ { "fileName": "src/lib/types.ts", "line": 194, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L194" } ], "type": { @@ -32343,7 +37867,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [686, 687] } ], @@ -32351,7 +37874,8 @@ { "fileName": "src/lib/types.ts", "line": 192, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L192" } ] } @@ -32367,7 +37891,8 @@ { "fileName": "src/lib/types.ts", "line": 196, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L196" } ], "type": { @@ -32379,7 +37904,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [684, 688] } ], @@ -32387,7 +37911,8 @@ { "fileName": "src/lib/types.ts", "line": 191, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L191" } ] } @@ -32411,7 +37936,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ], "type": { @@ -32433,7 +37959,8 @@ { "fileName": "src/lib/types.ts", "line": 200, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L200" } ], "type": { @@ -32452,7 +37979,8 @@ { "fileName": "src/lib/types.ts", "line": 201, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L201" } ], "type": { @@ -32464,7 +37992,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [692, 693] } ], @@ -32472,7 +37999,8 @@ { "fileName": "src/lib/types.ts", "line": 199, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L199" } ] } @@ -32488,12 +38016,13 @@ { "fileName": "src/lib/types.ts", "line": 203, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L203" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -32501,7 +38030,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [690, 694] } ], @@ -32509,7 +38037,8 @@ { "fileName": "src/lib/types.ts", "line": 198, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L198" } ] } @@ -32518,7 +38047,7 @@ } }, { - "id": 1179, + "id": 1184, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -32527,20 +38056,21 @@ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ], "type": { "type": "reflection", "declaration": { - "id": 1180, + "id": 1185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1186, "name": "page", "kind": 1024, "kindString": "Property", @@ -32548,13 +38078,19 @@ "isOptional": true }, "comment": { - "shortText": "The page number" + "summary": [ + { + "kind": "text", + "text": "The page number" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1215, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1215" } ], "type": { @@ -32563,7 +38099,7 @@ } }, { - "id": 1182, + "id": 1187, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -32571,13 +38107,19 @@ "isOptional": true }, "comment": { - "shortText": "Number of items returned per page" + "summary": [ + { + "kind": "text", + "text": "Number of items returned per page" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1217" } ], "type": { @@ -32589,22 +38131,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1181, 1182] + "children": [1186, 1187] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1213, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1213" } ] } } }, { - "id": 1172, + "id": 1177, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -32613,20 +38155,21 @@ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "type": { "type": "reflection", "declaration": { - "id": 1173, + "id": 1178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1175, + "id": 1180, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -32635,7 +38178,8 @@ { "fileName": "src/lib/types.ts", "line": 1209, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1209" } ], "type": { @@ -32644,7 +38188,7 @@ } }, { - "id": 1174, + "id": 1179, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -32653,7 +38197,8 @@ { "fileName": "src/lib/types.ts", "line": 1208, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1208" } ], "type": { @@ -32671,7 +38216,7 @@ } }, { - "id": 1176, + "id": 1181, "name": "total", "kind": 1024, "kindString": "Property", @@ -32680,7 +38225,8 @@ { "fileName": "src/lib/types.ts", "line": 1210, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1210" } ], "type": { @@ -32692,26 +38238,26 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1175, 1174, 1176] + "children": [1180, 1179, 1181] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1206, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1206" } ], "indexSignature": { - "id": 1177, + "id": 1182, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1178, + "id": 1183, "name": "key", "kind": 32768, "flags": {}, @@ -32736,13 +38282,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -32840,7 +38392,7 @@ } }, { - "id": 1229, + "id": 1234, "name": "RequiredClaims", "kind": 4194304, "kindString": "Type alias", @@ -32849,20 +38401,21 @@ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ], "type": { "type": "reflection", "declaration": { - "id": 1230, + "id": 1235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1237, + "id": 1242, "name": "aal", "kind": 1024, "kindString": "Property", @@ -32871,15 +38424,16 @@ { "fileName": "src/lib/types.ts", "line": 1321, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1321" } ], "type": { "type": "reference", - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "dereferenced": { - "id": 1091, + "id": 1096, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -32888,7 +38442,8 @@ { "fileName": "src/lib/types.ts", "line": 1008, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1008" } ], "type": { @@ -32908,7 +38463,7 @@ } }, { - "id": 1233, + "id": 1238, "name": "aud", "kind": 1024, "kindString": "Property", @@ -32917,7 +38472,8 @@ { "fileName": "src/lib/types.ts", "line": 1317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1317" } ], "type": { @@ -32938,7 +38494,7 @@ } }, { - "id": 1234, + "id": 1239, "name": "exp", "kind": 1024, "kindString": "Property", @@ -32947,7 +38503,8 @@ { "fileName": "src/lib/types.ts", "line": 1318, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1318" } ], "type": { @@ -32956,7 +38513,7 @@ } }, { - "id": 1235, + "id": 1240, "name": "iat", "kind": 1024, "kindString": "Property", @@ -32965,7 +38522,8 @@ { "fileName": "src/lib/types.ts", "line": 1319, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1319" } ], "type": { @@ -32974,7 +38532,7 @@ } }, { - "id": 1231, + "id": 1236, "name": "iss", "kind": 1024, "kindString": "Property", @@ -32983,7 +38541,8 @@ { "fileName": "src/lib/types.ts", "line": 1315, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1315" } ], "type": { @@ -32992,7 +38551,7 @@ } }, { - "id": 1236, + "id": 1241, "name": "role", "kind": 1024, "kindString": "Property", @@ -33001,7 +38560,8 @@ { "fileName": "src/lib/types.ts", "line": 1320, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1320" } ], "type": { @@ -33010,7 +38570,7 @@ } }, { - "id": 1238, + "id": 1243, "name": "session_id", "kind": 1024, "kindString": "Property", @@ -33019,7 +38579,8 @@ { "fileName": "src/lib/types.ts", "line": 1322, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1322" } ], "type": { @@ -33028,7 +38589,7 @@ } }, { - "id": 1232, + "id": 1237, "name": "sub", "kind": 1024, "kindString": "Property", @@ -33037,7 +38598,8 @@ { "fileName": "src/lib/types.ts", "line": 1316, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1316" } ], "type": { @@ -33049,22 +38611,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1237, 1233, 1234, 1235, 1231, 1236, 1238, 1232] + "children": [1242, 1238, 1239, 1240, 1236, 1241, 1243, 1237] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1314, - "character": 29 + "character": 29, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1314" } ] } } }, { - "id": 955, + "id": 960, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -33073,7 +38635,8 @@ { "fileName": "src/lib/types.ts", "line": 769, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L769" } ], "type": { @@ -33082,14 +38645,14 @@ { "type": "reflection", "declaration": { - "id": 956, + "id": 961, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 958, + "id": 963, "name": "email", "kind": 1024, "kindString": "Property", @@ -33098,7 +38661,8 @@ { "fileName": "src/lib/types.ts", "line": 772, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L772" } ], "type": { @@ -33107,7 +38671,7 @@ } }, { - "id": 959, + "id": 964, "name": "options", "kind": 1024, "kindString": "Property", @@ -33118,20 +38682,21 @@ { "fileName": "src/lib/types.ts", "line": 773, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ], "type": { "type": "reflection", "declaration": { - "id": 960, + "id": 965, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 962, + "id": 967, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33139,13 +38704,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 777, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L777" } ], "type": { @@ -33154,7 +38725,7 @@ } }, { - "id": 961, + "id": 966, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -33162,13 +38733,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 775, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L775" } ], "type": { @@ -33180,22 +38757,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [962, 961] + "children": [967, 966] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 773, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L773" } ] } } }, { - "id": 957, + "id": 962, "name": "type", "kind": 1024, "kindString": "Property", @@ -33204,7 +38781,8 @@ { "fileName": "src/lib/types.ts", "line": 771, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L771" } ], "type": { @@ -33212,7 +38790,7 @@ "typeArguments": [ { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType" }, { @@ -33229,24 +38807,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [958, 959, 957] + "children": [963, 964, 962] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 770, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L770" } ] } @@ -33254,14 +38832,14 @@ { "type": "reflection", "declaration": { - "id": 963, + "id": 968, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 966, + "id": 971, "name": "options", "kind": 1024, "kindString": "Property", @@ -33272,20 +38850,21 @@ { "fileName": "src/lib/types.ts", "line": 783, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ], "type": { "type": "reflection", "declaration": { - "id": 967, + "id": 972, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 968, + "id": 973, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33293,13 +38872,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 785, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L785" } ], "type": { @@ -33311,22 +38896,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [968] + "children": [973] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 783, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L783" } ] } } }, { - "id": 965, + "id": 970, "name": "phone", "kind": 1024, "kindString": "Property", @@ -33335,7 +38920,8 @@ { "fileName": "src/lib/types.ts", "line": 782, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L782" } ], "type": { @@ -33344,7 +38930,7 @@ } }, { - "id": 964, + "id": 969, "name": "type", "kind": 1024, "kindString": "Property", @@ -33353,7 +38939,8 @@ { "fileName": "src/lib/types.ts", "line": 781, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L781" } ], "type": { @@ -33361,7 +38948,7 @@ "typeArguments": [ { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType" }, { @@ -33378,24 +38965,24 @@ ] } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [966, 965, 964] + "children": [971, 970, 969] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 780, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L780" } ] } @@ -33413,7 +39000,8 @@ { "fileName": "src/lib/types.ts", "line": 206, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L206" } ], "type": { @@ -33438,7 +39026,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ], "type": { @@ -33457,14 +39046,27 @@ "kindString": "Property", "flags": {}, "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.", - "text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n" + "summary": [ + { + "kind": "text", + "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " + }, + { + "kind": "code", + "text": "`window.location.href`" + }, + { + "kind": "text", + "text": " to take\nthe user to the authentication flow." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 216, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L216" } ], "type": { @@ -33476,7 +39078,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [699] } ], @@ -33484,7 +39085,8 @@ { "fileName": "src/lib/types.ts", "line": 208, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L208" } ] } @@ -33500,7 +39102,8 @@ { "fileName": "src/lib/types.ts", "line": 218, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L218" } ], "type": { @@ -33512,7 +39115,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [697, 700] } ], @@ -33520,7 +39122,8 @@ { "fileName": "src/lib/types.ts", "line": 207, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L207" } ] } @@ -33544,7 +39147,8 @@ { "fileName": "src/lib/types.ts", "line": 221, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L221" } ], "type": { @@ -33562,12 +39166,13 @@ { "fileName": "src/lib/types.ts", "line": 222, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L222" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -33575,7 +39180,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [702, 703] } ], @@ -33583,7 +39187,8 @@ { "fileName": "src/lib/types.ts", "line": 220, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L220" } ] } @@ -33592,7 +39197,7 @@ } }, { - "id": 808, + "id": 810, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -33601,20 +39206,21 @@ { "fileName": "src/lib/types.ts", "line": 490, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ], "type": { "type": "reflection", "declaration": { - "id": 809, + "id": 811, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 812, "name": "options", "kind": 1024, "kindString": "Property", @@ -33625,20 +39231,21 @@ { "fileName": "src/lib/types.ts", "line": 491, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ], "type": { "type": "reflection", "declaration": { - "id": 811, + "id": 813, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 813, + "id": 815, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33646,13 +39253,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 499, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L499" } ], "type": { @@ -33661,7 +39274,7 @@ } }, { - "id": 812, + "id": 814, "name": "data", "kind": 1024, "kindString": "Property", @@ -33669,14 +39282,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 497, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L497" } ], "type": { @@ -33688,15 +39322,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [813, 812] + "children": [815, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 491, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L491" } ] } @@ -33706,22 +39340,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [810] + "children": [812] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 490, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L490" } ] } } }, { - "id": 874, + "id": 876, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -33730,20 +39364,21 @@ { "fileName": "src/lib/types.ts", "line": 617, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ], "type": { "type": "reflection", "declaration": { - "id": 875, + "id": 877, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 881, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -33751,13 +39386,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 623, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L623" } ], "type": { @@ -33766,7 +39415,7 @@ } }, { - "id": 880, + "id": 882, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -33774,13 +39423,27 @@ "isOptional": true }, "comment": { - "shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token." + "summary": [ + { + "kind": "text", + "text": "If the ID token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim, then the hash of this value is compared to the value in the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 625, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L625" } ], "type": { @@ -33789,7 +39452,7 @@ } }, { - "id": 881, + "id": 883, "name": "options", "kind": 1024, "kindString": "Property", @@ -33800,20 +39463,21 @@ { "fileName": "src/lib/types.ts", "line": 626, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ], "type": { "type": "reflection", "declaration": { - "id": 882, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 883, + "id": 885, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -33821,13 +39485,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 628, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L628" } ], "type": { @@ -33839,34 +39509,96 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [883] + "children": [885] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 626, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L626" } ] } } }, { - "id": 876, + "id": 878, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `kakao`, `keycloak` (deprecated)." + "summary": [ + { + "kind": "text", + "text": "Provider name or OIDC " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " value identifying which provider should be used to verify the provided token. Supported names: " + }, + { + "kind": "code", + "text": "`google`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`apple`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`azure`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`facebook`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`kakao`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`keycloak`" + }, + { + "kind": "text", + "text": " (deprecated)." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 619, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ], "type": { @@ -33902,7 +39634,7 @@ { "type": "reflection", "declaration": { - "id": 877, + "id": 879, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33911,7 +39643,8 @@ { "fileName": "src/lib/types.ts", "line": 619, - "character": 76 + "character": 76, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L619" } ] } @@ -33922,19 +39655,57 @@ } }, { - "id": 878, + "id": 880, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token." + "summary": [ + { + "kind": "text", + "text": "OIDC ID token issued by the specified provider. The " + }, + { + "kind": "code", + "text": "`iss`" + }, + { + "kind": "text", + "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " + }, + { + "kind": "code", + "text": "`at_hash`" + }, + { + "kind": "text", + "text": " which require that you provide an " + }, + { + "kind": "code", + "text": "`access_token`" + }, + { + "kind": "text", + "text": " value to be accepted properly. If the token contains a " + }, + { + "kind": "code", + "text": "`nonce`" + }, + { + "kind": "text", + "text": " claim you must supply the nonce used to obtain the ID token." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 621, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L621" } ], "type": { @@ -33946,22 +39717,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [879, 880, 881, 876, 878] + "children": [881, 882, 883, 878, 880] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 617, - "character": 43 + "character": 43, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L617" } ] } } }, { - "id": 862, + "id": 864, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -33970,20 +39741,21 @@ { "fileName": "src/lib/types.ts", "line": 602, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ], "type": { "type": "reflection", "declaration": { - "id": 863, + "id": 865, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 865, + "id": 867, "name": "options", "kind": 1024, "kindString": "Property", @@ -33994,20 +39766,21 @@ { "fileName": "src/lib/types.ts", "line": 605, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ], "type": { "type": "reflection", "declaration": { - "id": 866, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 869, + "id": 871, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -34015,19 +39788,25 @@ "isOptional": true }, "comment": { - "shortText": "An object of query params" + "summary": [ + { + "kind": "text", + "text": "An object of query params" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 611, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 872, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34036,18 +39815,19 @@ { "fileName": "src/lib/types.ts", "line": 611, - "character": 18 + "character": 18, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L611" } ], "indexSignature": { - "id": 871, + "id": 873, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 872, + "id": 874, "name": "key", "kind": 32768, "flags": {}, @@ -34066,7 +39846,7 @@ } }, { - "id": 867, + "id": 869, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -34074,13 +39854,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 607, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L607" } ], "type": { @@ -34089,7 +39875,7 @@ } }, { - "id": 868, + "id": 870, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -34097,13 +39883,19 @@ "isOptional": true }, "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." + "summary": [ + { + "kind": "text", + "text": "A space-separated list of scopes granted to the OAuth application." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 609, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L609" } ], "type": { @@ -34112,7 +39904,7 @@ } }, { - "id": 873, + "id": 875, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -34120,13 +39912,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + "summary": [ + { + "kind": "text", + "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 613, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L613" } ], "type": { @@ -34138,34 +39936,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [869, 867, 868, 873] + "children": [871, 869, 870, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 605, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L605" } ] } } }, { - "id": 864, + "id": 866, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 604, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L604" } ], "type": { @@ -34179,13 +39983,19 @@ "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "One of the providers supported by GoTrue." + "summary": [ + { + "kind": "text", + "text": "One of the providers supported by GoTrue." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 8, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L8" } ], "type": { @@ -34288,22 +40098,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [865, 864] + "children": [867, 866] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 602, - "character": 41 + "character": 41, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L602" } ] } } }, { - "id": 831, + "id": 833, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -34312,7 +40122,8 @@ { "fileName": "src/lib/types.ts", "line": 541, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L541" } ], "type": { @@ -34321,26 +40132,32 @@ { "type": "reflection", "declaration": { - "id": 832, + "id": 834, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 835, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 544, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L544" } ], "type": { @@ -34349,7 +40166,7 @@ } }, { - "id": 835, + "id": 837, "name": "options", "kind": 1024, "kindString": "Property", @@ -34360,20 +40177,21 @@ { "fileName": "src/lib/types.ts", "line": 547, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ], "type": { "type": "reflection", "declaration": { - "id": 836, + "id": 838, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 837, + "id": 839, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34381,13 +40199,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 549, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L549" } ], "type": { @@ -34399,34 +40223,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [837] + "children": [839] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 547, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L547" } ] } } }, { - "id": 834, + "id": 836, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 546, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L546" } ], "type": { @@ -34438,15 +40268,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [833, 835, 834] + "children": [835, 837, 836] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 542, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L542" } ] } @@ -34454,14 +40284,14 @@ { "type": "reflection", "declaration": { - "id": 838, + "id": 840, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 841, + "id": 843, "name": "options", "kind": 1024, "kindString": "Property", @@ -34472,20 +40302,21 @@ { "fileName": "src/lib/types.ts", "line": 557, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 844, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 843, + "id": 845, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34493,13 +40324,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 559, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L559" } ], "type": { @@ -34511,34 +40348,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [843] + "children": [845] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 557, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L557" } ] } } }, { - "id": 840, + "id": 842, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 556, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L556" } ], "type": { @@ -34547,19 +40390,25 @@ } }, { - "id": 839, + "id": 841, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 554, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L554" } ], "type": { @@ -34571,15 +40420,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [841, 840, 839] + "children": [843, 842, 841] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 552, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L552" } ] } @@ -34588,7 +40437,7 @@ } }, { - "id": 844, + "id": 846, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -34597,7 +40446,8 @@ { "fileName": "src/lib/types.ts", "line": 563, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L563" } ], "type": { @@ -34606,26 +40456,32 @@ { "type": "reflection", "declaration": { - "id": 845, + "id": 847, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 846, + "id": 848, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 566, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L566" } ], "type": { @@ -34634,7 +40490,7 @@ } }, { - "id": 847, + "id": 849, "name": "options", "kind": 1024, "kindString": "Property", @@ -34645,20 +40501,21 @@ { "fileName": "src/lib/types.ts", "line": 567, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ], "type": { "type": "reflection", "declaration": { - "id": 848, + "id": 850, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 852, + "id": 854, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34666,13 +40523,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 579, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L579" } ], "type": { @@ -34681,7 +40544,7 @@ } }, { - "id": 851, + "id": 853, "name": "data", "kind": 1024, "kindString": "Property", @@ -34689,14 +40552,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 577, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L577" } ], "type": { @@ -34705,7 +40589,7 @@ } }, { - "id": 849, + "id": 851, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -34713,13 +40597,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 569, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L569" } ], "type": { @@ -34728,7 +40618,7 @@ } }, { - "id": 850, + "id": 852, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -34736,13 +40626,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 571, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L571" } ], "type": { @@ -34754,15 +40650,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [852, 851, 849, 850] + "children": [854, 853, 851, 852] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 567, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L567" } ] } @@ -34772,15 +40668,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [846, 847] + "children": [848, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 564, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L564" } ] } @@ -34788,14 +40684,14 @@ { "type": "reflection", "declaration": { - "id": 853, + "id": 855, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 855, + "id": 857, "name": "options", "kind": 1024, "kindString": "Property", @@ -34806,20 +40702,21 @@ { "fileName": "src/lib/types.ts", "line": 585, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ], "type": { "type": "reflection", "declaration": { - "id": 856, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 859, + "id": 861, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34827,13 +40724,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 595, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L595" } ], "type": { @@ -34842,7 +40745,7 @@ } }, { - "id": 860, + "id": 862, "name": "channel", "kind": 1024, "kindString": "Property", @@ -34850,13 +40753,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 597, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L597" } ], "type": { @@ -34874,7 +40783,7 @@ } }, { - "id": 858, + "id": 860, "name": "data", "kind": 1024, "kindString": "Property", @@ -34882,14 +40791,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 593, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L593" } ], "type": { @@ -34898,7 +40828,7 @@ } }, { - "id": 857, + "id": 859, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -34906,13 +40836,19 @@ "isOptional": true }, "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "If set to false, this method will not create a new user. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 587, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L587" } ], "type": { @@ -34924,34 +40860,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [859, 860, 858, 857] + "children": [861, 862, 860, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 585, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L585" } ] } } }, { - "id": 854, + "id": 856, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 584, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L584" } ], "type": { @@ -34963,15 +40905,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [855, 854] + "children": [857, 856] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 582, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L582" } ] } @@ -34980,7 +40922,7 @@ } }, { - "id": 969, + "id": 974, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -34989,7 +40931,8 @@ { "fileName": "src/lib/types.ts", "line": 789, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L789" } ], "type": { @@ -34998,14 +40941,14 @@ { "type": "reflection", "declaration": { - "id": 970, + "id": 975, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 972, + "id": 977, "name": "options", "kind": 1024, "kindString": "Property", @@ -35016,20 +40959,21 @@ { "fileName": "src/lib/types.ts", "line": 794, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ], "type": { "type": "reflection", "declaration": { - "id": 973, + "id": 978, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 975, + "id": 980, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35037,13 +40981,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 798, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L798" } ], "type": { @@ -35052,7 +41002,7 @@ } }, { - "id": 974, + "id": 979, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -35060,13 +41010,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 796, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L796" } ], "type": { @@ -35078,34 +41034,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [975, 974] + "children": [980, 979] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 794, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L794" } ] } } }, { - "id": 971, + "id": 976, "name": "providerId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." + "summary": [ + { + "kind": "text", + "text": "UUID of the SSO provider to invoke single-sign on to." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 792, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L792" } ], "type": { @@ -35117,15 +41079,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [972, 971] + "children": [977, 976] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 790, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L790" } ] } @@ -35133,26 +41095,32 @@ { "type": "reflection", "declaration": { - "id": 976, + "id": 981, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 977, + "id": 982, "name": "domain", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." + "summary": [ + { + "kind": "text", + "text": "Domain name of the organization for which to invoke single-sign on." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 803, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L803" } ], "type": { @@ -35161,7 +41129,7 @@ } }, { - "id": 978, + "id": 983, "name": "options", "kind": 1024, "kindString": "Property", @@ -35172,20 +41140,21 @@ { "fileName": "src/lib/types.ts", "line": 805, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ], "type": { "type": "reflection", "declaration": { - "id": 979, + "id": 984, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 981, + "id": 986, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35193,13 +41162,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 809, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L809" } ], "type": { @@ -35208,7 +41183,7 @@ } }, { - "id": 980, + "id": 985, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -35216,13 +41191,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they have signed-in." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they have signed-in." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 807, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L807" } ], "type": { @@ -35234,15 +41215,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [981, 980] + "children": [986, 985] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 805, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L805" } ] } @@ -35252,15 +41233,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [977, 978] + "children": [982, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 801, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L801" } ] } @@ -35269,7 +41250,7 @@ } }, { - "id": 1183, + "id": 1188, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -35278,20 +41259,21 @@ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ], "type": { "type": "reflection", "declaration": { - "id": 1184, + "id": 1189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1185, + "id": 1190, "name": "scope", "kind": 1024, "kindString": "Property", @@ -35299,13 +41281,19 @@ "isOptional": true }, "comment": { - "shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + "summary": [ + { + "kind": "text", + "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1231, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1231" } ], "type": { @@ -35330,22 +41318,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1185] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1220, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1220" } ] } } }, { - "id": 1251, + "id": 1256, "name": "SignOutScope", "kind": 4194304, "kindString": "Type alias", @@ -35354,7 +41342,8 @@ { "fileName": "src/lib/types.ts", "line": 1338, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1338" } ], "type": { @@ -35367,14 +41356,14 @@ "type": "query", "queryType": { "type": "reference", - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES" } } } }, { - "id": 814, + "id": 816, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -35383,7 +41372,8 @@ { "fileName": "src/lib/types.ts", "line": 503, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L503" } ], "type": { @@ -35392,26 +41382,32 @@ { "type": "reflection", "declaration": { - "id": 815, + "id": 817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 818, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 506, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L506" } ], "type": { @@ -35420,7 +41416,7 @@ } }, { - "id": 818, + "id": 820, "name": "options", "kind": 1024, "kindString": "Property", @@ -35431,20 +41427,21 @@ { "fileName": "src/lib/types.ts", "line": 509, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ], "type": { "type": "reflection", "declaration": { - "id": 819, + "id": 821, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 822, + "id": 824, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35452,13 +41449,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 519, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L519" } ], "type": { @@ -35467,7 +41470,7 @@ } }, { - "id": 821, + "id": 823, "name": "data", "kind": 1024, "kindString": "Property", @@ -35475,14 +41478,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 517, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L517" } ], "type": { @@ -35491,7 +41515,7 @@ } }, { - "id": 820, + "id": 822, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -35499,13 +41523,19 @@ "isOptional": true }, "comment": { - "shortText": "The redirect url embedded in the email link" + "summary": [ + { + "kind": "text", + "text": "The redirect url embedded in the email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 511, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L511" } ], "type": { @@ -35517,34 +41547,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [822, 821, 820] + "children": [824, 823, 822] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 509, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L509" } ] } } }, { - "id": 817, + "id": 819, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 508, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L508" } ], "type": { @@ -35556,15 +41592,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [816, 818, 817] + "children": [818, 820, 819] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 504, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L504" } ] } @@ -35572,14 +41608,14 @@ { "type": "reflection", "declaration": { - "id": 823, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 826, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -35590,20 +41626,21 @@ { "fileName": "src/lib/types.ts", "line": 527, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35611,13 +41648,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 535, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L535" } ], "type": { @@ -35626,7 +41669,7 @@ } }, { - "id": 830, + "id": 832, "name": "channel", "kind": 1024, "kindString": "Property", @@ -35634,13 +41677,19 @@ "isOptional": true }, "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "summary": [ + { + "kind": "text", + "text": "Messaging channel to use (e.g. whatsapp or sms)" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 537, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L537" } ], "type": { @@ -35658,7 +41707,7 @@ } }, { - "id": 828, + "id": 830, "name": "data", "kind": 1024, "kindString": "Property", @@ -35666,14 +41715,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.raw_user_meta_data` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + "summary": [ + { + "kind": "text", + "text": "A custom data object to store the user's metadata. This maps to the " + }, + { + "kind": "code", + "text": "`auth.users.raw_user_meta_data`" + }, + { + "kind": "text", + "text": " column.\n\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " should be a JSON object that includes user-specific info, such as their first and last name." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 533, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L533" } ], "type": { @@ -35685,34 +41755,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [829, 830, 828] + "children": [831, 832, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 527, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L527" } ] } } }, { - "id": 825, + "id": 827, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's password." + "summary": [ + { + "kind": "text", + "text": "The user's password." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 526, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L526" } ], "type": { @@ -35721,19 +41797,25 @@ } }, { - "id": 824, + "id": 826, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 524, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L524" } ], "type": { @@ -35745,15 +41827,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [826, 825, 824] + "children": [828, 827, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 522, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L522" } ] } @@ -35762,7 +41844,7 @@ } }, { - "id": 884, + "id": 886, "name": "SolanaWallet", "kind": 4194304, "kindString": "Type alias", @@ -35771,20 +41853,21 @@ { "fileName": "src/lib/types.ts", "line": 632, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ], "type": { "type": "reflection", "declaration": { - "id": 885, + "id": 887, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 889, + "id": 892, "name": "publicKey", "kind": 1024, "kindString": "Property", @@ -35795,7 +41878,8 @@ { "fileName": "src/lib/types.ts", "line": 634, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ], "type": { @@ -35804,52 +41888,71 @@ { "type": "reflection", "declaration": { - "id": 890, + "id": 893, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 891, + "id": 894, "name": "toBase58", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", "line": 635, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" } ], - "signatures": [ - { - "id": 892, - "name": "toBase58", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 895, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 635, + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L635" + } + ], + "signatures": [ + { + "id": 896, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] } - ] + } } ], "groups": [ { - "title": "Methods", - "kind": 2048, - "children": [891] + "title": "Properties", + "children": [894] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 634, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L634" } ] } @@ -35862,10 +41965,10 @@ } }, { - "id": 886, + "id": 888, "name": "signIn", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -35873,66 +41976,85 @@ { "fileName": "src/lib/types.ts", "line": 633, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "signatures": [ - { - "id": 887, - "name": "signIn", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 889, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ + "sources": [ { - "id": 888, - "name": "inputs", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "SolanaSignInInput" - } - } + "fileName": "src/lib/types.ts", + "line": 633, + "character": 11, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L633" } ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "SolanaSignInOutput" + "signatures": [ + { + "id": 890, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 891, + "name": "inputs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isRest": true }, - { + "type": { "type": "array", "elementType": { "type": "reference", - "name": "SolanaSignInOutput" + "name": "SolanaSignInInput" } } - ] + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "SolanaSignInOutput" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "name": "SolanaSignInOutput" + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } + } + ] } - ] + } }, { - "id": 893, + "id": 897, "name": "signMessage", - "kind": 2048, - "kindString": "Method", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, @@ -35940,95 +42062,118 @@ { "fileName": "src/lib/types.ts", "line": 638, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "signatures": [ - { - "id": 894, - "name": "signMessage", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 898, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "parameters": [ - { - "id": 895, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - }, + "sources": [ { - "id": 896, - "name": "encoding", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } + "fileName": "src/lib/types.ts", + "line": 638, + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L638" } ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 899, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 900, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + }, + { + "id": 901, + "name": "encoding", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "utf8" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Uint8Array", + "qualifiedName": "Uint8Array", + "package": "typescript" + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] } - ] - } + } + ] } - ] + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [889] - }, - { - "title": "Methods", - "kind": 2048, - "children": [886, 893] + "children": [892, 888, 897] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 632, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L632" } ] } } }, { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -36037,7 +42182,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -36046,14 +42192,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -36062,7 +42208,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -36071,7 +42218,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -36082,20 +42229,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36103,13 +42251,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -36118,7 +42272,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -36129,7 +42283,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -36168,18 +42323,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -36187,13 +42342,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -36205,22 +42366,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -36228,13 +42389,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -36243,7 +42410,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -36251,18 +42418,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -36270,15 +42451,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -36286,14 +42467,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -36302,7 +42483,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -36311,19 +42493,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -36332,7 +42544,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -36343,20 +42555,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36364,13 +42577,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -36382,56 +42601,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -36440,7 +42665,7 @@ } }, { - "id": 1159, + "id": 1164, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -36449,7 +42674,8 @@ { "fileName": "src/lib/types.ts", "line": 1181, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1181" } ], "type": { @@ -36463,9 +42689,9 @@ "typeArguments": [ { "type": "reference", + "name": "Storage", "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" + "package": "typescript" }, { "type": "union", @@ -36485,9 +42711,9 @@ ] } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } ], "name": "PromisifyMethods" @@ -36495,14 +42721,14 @@ { "type": "reflection", "declaration": { - "id": 1160, + "id": 1165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1161, + "id": 1166, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -36510,13 +42736,27 @@ "isOptional": true }, "comment": { - "shortText": "If set to `true` signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + "summary": [ + { + "kind": "text", + "text": "If set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 1191, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1191" } ], "type": { @@ -36528,15 +42768,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [1161] + "children": [1166] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1183, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1183" } ] } @@ -36554,7 +42794,8 @@ { "fileName": "src/lib/types.ts", "line": 225, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L225" } ], "type": { @@ -36579,7 +42820,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ], "type": { @@ -36601,7 +42843,8 @@ { "fileName": "src/lib/types.ts", "line": 228, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L228" } ], "type": { @@ -36614,7 +42857,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [708] } ], @@ -36622,7 +42864,8 @@ { "fileName": "src/lib/types.ts", "line": 227, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L227" } ] } @@ -36638,7 +42881,8 @@ { "fileName": "src/lib/types.ts", "line": 230, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L230" } ], "type": { @@ -36650,7 +42894,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [706, 709] } ], @@ -36658,7 +42901,8 @@ { "fileName": "src/lib/types.ts", "line": 226, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L226" } ] } @@ -36682,7 +42926,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ], "type": { @@ -36704,7 +42949,8 @@ { "fileName": "src/lib/types.ts", "line": 234, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L234" } ], "type": { @@ -36716,7 +42962,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [713] } ], @@ -36724,7 +42969,8 @@ { "fileName": "src/lib/types.ts", "line": 233, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L233" } ] } @@ -36740,12 +42986,13 @@ { "fileName": "src/lib/types.ts", "line": 236, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L236" } ], "type": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -36753,7 +43000,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [711, 714] } ], @@ -36761,7 +43007,8 @@ { "fileName": "src/lib/types.ts", "line": 232, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L232" } ] } @@ -36770,7 +43017,7 @@ } }, { - "id": 933, + "id": 938, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -36779,21 +43026,22 @@ { "fileName": "src/lib/types.ts", "line": 719, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L719" } ], "type": { "type": "union", "types": [ { - "id": 934, + "id": 939, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 938, + "id": 943, "name": "options", "kind": 1024, "kindString": "Property", @@ -36804,20 +43052,21 @@ { "fileName": "src/lib/types.ts", "line": 727, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ], "type": { "type": "reflection", "declaration": { - "id": 939, + "id": 944, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 941, + "id": 946, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36825,11 +43074,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -36837,7 +43091,8 @@ { "fileName": "src/lib/types.ts", "line": 736, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L736" } ], "type": { @@ -36846,7 +43101,7 @@ } }, { - "id": 940, + "id": 945, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -36854,13 +43109,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 729, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L729" } ], "type": { @@ -36872,27 +43133,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [941, 940] + "children": [946, 945] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 727, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L727" } ] } } }, { - "id": 935, + "id": 940, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's phone number." + "summary": [ + { + "kind": "text", + "text": "The user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 722, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L722" } ], "type": { @@ -36901,19 +43175,25 @@ } }, { - "id": 936, + "id": 941, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's phone number." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's phone number." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 724, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L724" } ], "type": { @@ -36922,27 +43202,33 @@ } }, { - "id": 937, + "id": 942, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 726, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L726" } ], "type": { "type": "reference", - "id": 953, + "id": 958, "name": "MobileOtpType", "dereferenced": { - "id": 953, + "id": 958, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -36951,7 +43237,8 @@ { "fileName": "src/lib/types.ts", "line": 766, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L766" } ], "type": { @@ -36974,39 +43261,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [938, 935, 936, 937] + "children": [943, 940, 941, 942] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 720, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L720" } ] }, { - "id": 942, + "id": 947, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 943, + "id": 948, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's email address." + "summary": [ + { + "kind": "text", + "text": "The user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 741, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L741" } ], "type": { @@ -37015,7 +43308,7 @@ } }, { - "id": 946, + "id": 951, "name": "options", "kind": 1024, "kindString": "Property", @@ -37026,20 +43319,21 @@ { "fileName": "src/lib/types.ts", "line": 746, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ], "type": { "type": "reflection", "declaration": { - "id": 947, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 949, + "id": 954, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37047,11 +43341,16 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ + "summary": [ { - "tag": "deprecated", - "text": "\n" + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] } ] }, @@ -37059,7 +43358,8 @@ { "fileName": "src/lib/types.ts", "line": 754, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L754" } ], "type": { @@ -37068,7 +43368,7 @@ } }, { - "id": 948, + "id": 953, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -37076,13 +43376,19 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "summary": [ + { + "kind": "text", + "text": "A URL to send the user to after they are confirmed." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 748, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L748" } ], "type": { @@ -37094,27 +43400,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [949, 948] + "children": [954, 953] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 746, + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L746" } ] } } }, { - "id": 944, + "id": 949, "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "summary": [ + { + "kind": "text", + "text": "The otp sent to the user's email address." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 743, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L743" } ], "type": { @@ -37123,27 +43442,33 @@ } }, { - "id": 945, + "id": 950, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 745, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L745" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -37152,7 +43477,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -37191,39 +43517,45 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [943, 946, 944, 945] + "children": [948, 951, 949, 950] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 739, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L739" } ] }, { - "id": 950, + "id": 955, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 951, + "id": 956, "name": "token_hash", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "summary": [ + { + "kind": "text", + "text": "The token hash used in an email link" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 760, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L760" } ], "type": { @@ -37232,27 +43564,33 @@ } }, { - "id": 952, + "id": 957, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The user's verification type." + "summary": [ + { + "kind": "text", + "text": "The user's verification type." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 763, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L763" } ], "type": { "type": "reference", - "id": 954, + "id": 959, "name": "EmailOtpType", "dereferenced": { - "id": 954, + "id": 959, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -37261,7 +43599,8 @@ { "fileName": "src/lib/types.ts", "line": 767, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L767" } ], "type": { @@ -37300,15 +43639,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [951, 952] + "children": [956, 957] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 758, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L758" } ] } @@ -37325,7 +43664,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ], "type": { @@ -37347,7 +43687,8 @@ { "fileName": "src/lib/types.ts", "line": 105, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L105" } ], "type": { @@ -37365,7 +43706,8 @@ { "fileName": "src/lib/types.ts", "line": 104, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L104" } ], "type": { @@ -37381,7 +43723,6 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [611, 610] } ], @@ -37389,7 +43730,8 @@ { "fileName": "src/lib/types.ts", "line": 103, - "character": 27 + "character": 27, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L103" } ] } @@ -37405,7 +43747,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ], "type": { @@ -37442,7 +43785,8 @@ { "fileName": "src/lib/types.ts", "line": 102, - "character": 80 + "character": 80, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L102" } ] } @@ -37453,7 +43797,7 @@ } }, { - "id": 932, + "id": 937, "name": "Web3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -37462,14 +43806,15 @@ { "fileName": "src/lib/types.ts", "line": 717, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L717" } ], "type": { "type": "union", "types": [ { - "id": 897, + "id": 902, "name": "SolanaWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -37478,7 +43823,8 @@ { "fileName": "src/lib/types.ts", "line": 641, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L641" } ], "type": { @@ -37487,14 +43833,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 904, "name": "chain", "kind": 1024, "kindString": "Property", @@ -37503,7 +43849,8 @@ { "fileName": "src/lib/types.ts", "line": 643, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L643" } ], "type": { @@ -37512,7 +43859,7 @@ } }, { - "id": 902, + "id": 907, "name": "options", "kind": 1024, "kindString": "Property", @@ -37523,20 +43870,21 @@ { "fileName": "src/lib/types.ts", "line": 651, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ], "type": { "type": "reflection", "declaration": { - "id": 903, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 905, + "id": 910, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37544,13 +43892,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 656, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L656" } ], "type": { @@ -37559,7 +43913,7 @@ } }, { - "id": 906, + "id": 911, "name": "signInWithSolana", "kind": 1024, "kindString": "Property", @@ -37570,7 +43924,8 @@ { "fileName": "src/lib/types.ts", "line": 658, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L658" } ], "type": { @@ -37609,18 +43964,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 904, + "id": 909, "name": "url", "kind": 1024, "kindString": "Property", @@ -37628,13 +43983,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 653, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L653" } ], "type": { @@ -37646,22 +44007,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [905, 906, 904] + "children": [910, 911, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 651, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L651" } ] } } }, { - "id": 901, + "id": 906, "name": "statement", "kind": 1024, "kindString": "Property", @@ -37669,13 +44030,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 649, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L649" } ], "type": { @@ -37684,7 +44051,7 @@ } }, { - "id": 900, + "id": 905, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -37692,18 +44059,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 646, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L646" } ], "type": { "type": "reference", - "id": 884, + "id": 886, "name": "SolanaWallet" } } @@ -37711,15 +44092,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [899, 902, 901, 900] + "children": [904, 907, 906, 905] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 642, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L642" } ] } @@ -37727,14 +44108,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 913, "name": "chain", "kind": 1024, "kindString": "Property", @@ -37743,7 +44124,8 @@ { "fileName": "src/lib/types.ts", "line": 664, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L664" } ], "type": { @@ -37752,19 +44134,49 @@ } }, { - "id": 909, + "id": 914, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Solana compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Solana compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 667, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L667" } ], "type": { @@ -37773,7 +44185,7 @@ } }, { - "id": 911, + "id": 916, "name": "options", "kind": 1024, "kindString": "Property", @@ -37784,20 +44196,21 @@ { "fileName": "src/lib/types.ts", "line": 672, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { - "id": 912, + "id": 917, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 913, + "id": 918, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37805,13 +44218,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 674, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L674" } ], "type": { @@ -37823,56 +44242,62 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [913] + "children": [918] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 672, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L672" } ] } } }, { - "id": 910, + "id": 915, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 670, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L670" } ], "type": { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [908, 909, 911, 910] + "children": [913, 914, 916, 915] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 663, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L663" } ] } @@ -37881,7 +44306,7 @@ } }, { - "id": 915, + "id": 920, "name": "EthereumWeb3Credentials", "kind": 4194304, "kindString": "Type alias", @@ -37890,7 +44315,8 @@ { "fileName": "src/lib/types.ts", "line": 680, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L680" } ], "type": { @@ -37899,14 +44325,14 @@ { "type": "reflection", "declaration": { - "id": 916, + "id": 921, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 917, + "id": 922, "name": "chain", "kind": 1024, "kindString": "Property", @@ -37915,7 +44341,8 @@ { "fileName": "src/lib/types.ts", "line": 682, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L682" } ], "type": { @@ -37924,7 +44351,7 @@ } }, { - "id": 920, + "id": 925, "name": "options", "kind": 1024, "kindString": "Property", @@ -37935,20 +44362,21 @@ { "fileName": "src/lib/types.ts", "line": 690, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ], "type": { "type": "reflection", "declaration": { - "id": 921, + "id": 926, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 923, + "id": 928, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37956,13 +44384,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 695, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L695" } ], "type": { @@ -37971,7 +44405,7 @@ } }, { - "id": 924, + "id": 929, "name": "signInWithEthereum", "kind": 1024, "kindString": "Property", @@ -37982,7 +44416,8 @@ { "fileName": "src/lib/types.ts", "line": 697, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L697" } ], "type": { @@ -38017,18 +44452,18 @@ ] } ], + "name": "Omit", "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" + "package": "typescript" } ], + "name": "Partial", "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" + "package": "typescript" } }, { - "id": 922, + "id": 927, "name": "url", "kind": 1024, "kindString": "Property", @@ -38036,13 +44471,19 @@ "isOptional": true }, "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + "summary": [ + { + "kind": "text", + "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 692, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L692" } ], "type": { @@ -38054,22 +44495,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [923, 924, 922] + "children": [928, 929, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 690, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L690" } ] } } }, { - "id": 919, + "id": 924, "name": "statement", "kind": 1024, "kindString": "Property", @@ -38077,13 +44518,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + "summary": [ + { + "kind": "text", + "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 688, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L688" } ], "type": { @@ -38092,7 +44539,7 @@ } }, { - "id": 918, + "id": 923, "name": "wallet", "kind": 1024, "kindString": "Property", @@ -38100,18 +44547,32 @@ "isOptional": true }, "comment": { - "shortText": "Wallet interface to use. If not specified will default to `window.solana`." + "summary": [ + { + "kind": "text", + "text": "Wallet interface to use. If not specified will default to " + }, + { + "kind": "code", + "text": "`window.solana`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 685, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L685" } ], "type": { "type": "reference", - "id": 914, + "id": 919, "name": "EthereumWallet" } } @@ -38119,15 +44580,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [917, 920, 919, 918] + "children": [922, 925, 924, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 681, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L681" } ] } @@ -38135,14 +44596,14 @@ { "type": "reflection", "declaration": { - "id": 925, + "id": 930, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 926, + "id": 931, "name": "chain", "kind": 1024, "kindString": "Property", @@ -38151,7 +44612,8 @@ { "fileName": "src/lib/types.ts", "line": 703, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L703" } ], "type": { @@ -38160,19 +44622,49 @@ } }, { - "id": 927, + "id": 932, "name": "message", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include `Issued At`, `URI` and `Version`." + "summary": [ + { + "kind": "text", + "text": "Sign in with Ethereum compatible message. Must include " + }, + { + "kind": "code", + "text": "`Issued At`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`URI`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`Version`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 706, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L706" } ], "type": { @@ -38181,7 +44673,7 @@ } }, { - "id": 929, + "id": 934, "name": "options", "kind": 1024, "kindString": "Property", @@ -38192,20 +44684,21 @@ { "fileName": "src/lib/types.ts", "line": 711, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ], "type": { "type": "reflection", "declaration": { - "id": 930, + "id": 935, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 931, + "id": 936, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -38213,13 +44706,19 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." + "summary": [ + { + "kind": "text", + "text": "Verification token received when the user completes the captcha on the site." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 713, - "character": 8 + "character": 8, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L713" } ], "type": { @@ -38231,34 +44730,40 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [931] + "children": [936] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 711, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L711" } ] } } }, { - "id": 928, + "id": 933, "name": "signature", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Ed25519 signature of the message." + "summary": [ + { + "kind": "text", + "text": "Ed25519 signature of the message." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 709, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L709" } ], "type": { @@ -38270,15 +44775,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [926, 927, 929, 928] + "children": [931, 932, 934, 933] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 702, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L702" } ] } @@ -38301,7 +44806,8 @@ { "fileName": "src/AuthAdminApi.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthAdminApi.ts#L3" } ], "type": { @@ -38326,7 +44832,8 @@ { "fileName": "src/AuthClient.ts", "line": 3, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/AuthClient.ts#L3" } ], "type": { @@ -38340,7 +44847,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 1250, + "id": 1255, "name": "SIGN_OUT_SCOPES", "kind": 32, "kindString": "Variable", @@ -38351,7 +44858,8 @@ { "fileName": "src/lib/types.ts", "line": 1337, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/types.ts#L1337" } ], "type": { @@ -38386,18 +44894,15 @@ "isConst": true }, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 6, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" } ], "type": { @@ -38416,18 +44921,15 @@ "kindString": "Property", "flags": {}, "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] + "summary": [], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/locks.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L10" } ], "type": { @@ -38440,16 +44942,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [563] } + ], + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 6, + "character": 25, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L6" + } ] } }, "defaultValue": "..." }, { - "id": 1255, + "id": 1260, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -38458,19 +44967,20 @@ { "fileName": "src/lib/errors.ts", "line": 41, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L41" } ], "signatures": [ { - "id": 1256, + "id": 1261, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1257, + "id": 1262, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38487,7 +44997,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1280, + "id": 1285, "name": "AuthApiError" } } @@ -38495,7 +45005,7 @@ ] }, { - "id": 1252, + "id": 1257, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -38504,19 +45014,20 @@ { "fileName": "src/lib/errors.ts", "line": 26, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L26" } ], "signatures": [ { - "id": 1253, + "id": 1258, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1254, + "id": 1259, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38533,7 +45044,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1270, + "id": 1275, "name": "AuthError" } } @@ -38541,7 +45052,7 @@ ] }, { - "id": 1261, + "id": 1266, "name": "isAuthImplicitGrantRedirectError", "kind": 64, "kindString": "Function", @@ -38550,19 +45061,20 @@ { "fileName": "src/lib/errors.ts", "line": 105, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L105" } ], "signatures": [ { - "id": 1262, + "id": 1267, "name": "isAuthImplicitGrantRedirectError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1263, + "id": 1268, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38579,7 +45091,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1337, + "id": 1342, "name": "AuthImplicitGrantRedirectError" } } @@ -38587,7 +45099,7 @@ ] }, { - "id": 1264, + "id": 1269, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -38596,19 +45108,20 @@ { "fileName": "src/lib/errors.ts", "line": 135, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L135" } ], "signatures": [ { - "id": 1265, + "id": 1270, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1266, + "id": 1271, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38625,7 +45138,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1391, + "id": 1396, "name": "AuthRetryableFetchError" } } @@ -38633,7 +45146,7 @@ ] }, { - "id": 1258, + "id": 1263, "name": "isAuthSessionMissingError", "kind": 64, "kindString": "Function", @@ -38642,19 +45155,20 @@ { "fileName": "src/lib/errors.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L72" } ], "signatures": [ { - "id": 1259, + "id": 1264, "name": "isAuthSessionMissingError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1260, + "id": 1265, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38671,7 +45185,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1312, + "id": 1317, "name": "AuthSessionMissingError" } } @@ -38679,7 +45193,7 @@ ] }, { - "id": 1267, + "id": 1272, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -38688,19 +45202,20 @@ { "fileName": "src/lib/errors.ts", "line": 157, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/errors.ts#L157" } ], "signatures": [ { - "id": 1268, + "id": 1273, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1269, + "id": 1274, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38717,7 +45232,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1401, + "id": 1406, "name": "AuthWeakPasswordError" } } @@ -38734,7 +45249,8 @@ { "fileName": "src/lib/locks.ts", "line": 59, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L59" } ], "signatures": [ @@ -38745,8 +45261,54 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring {@link\nGoTrueClient}.", - "text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "GoTrueClient", + "target": 78 + }, + { + "kind": "text", + "text": ".\n\nYou can turn on debugging by setting the " + }, + { + "kind": "code", + "text": "`supabase.gotrue-js.locks.debug`" + }, + { + "kind": "text", + "text": "\nlocal storage item to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " + }, + { + "kind": "code", + "text": "`request`" + }, + { + "kind": "text", + "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " + }, + { + "kind": "code", + "text": "`fn`" + }, + { + "kind": "text", + "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." + } + ] }, "typeParameter": [ { @@ -38765,7 +45327,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -38779,7 +45346,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -38793,7 +45373,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -38803,6 +45388,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 62, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L62" + } + ], "signatures": [ { "id": 555, @@ -38819,9 +45412,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38838,9 +45431,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38855,7 +45448,8 @@ { "fileName": "src/lib/locks.ts", "line": 171, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L171" } ], "signatures": [ @@ -38866,8 +45460,22 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.", - "text": "Use {@link #navigatorLock} in browser environments.\n" + "summary": [ + { + "kind": "text", + "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "#navigatorLock", + "target": 0 + }, + { + "kind": "text", + "text": " in browser environments." + } + ] }, "typeParameter": [ { @@ -38886,7 +45494,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Name of the lock to be acquired." + "summary": [ + { + "kind": "text", + "text": "Name of the lock to be acquired." + } + ] }, "type": { "type": "intrinsic", @@ -38900,7 +45513,20 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true." + "summary": [ + { + "kind": "text", + "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " + }, + { + "kind": "code", + "text": "`isAcquireTimeout`" + }, + { + "kind": "text", + "text": " set to true." + } + ] }, "type": { "type": "intrinsic", @@ -38914,7 +45540,12 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operation to run once the lock is acquired.\n" + "summary": [ + { + "kind": "text", + "text": "The operation to run once the lock is acquired." + } + ] }, "type": { "type": "reflection", @@ -38924,6 +45555,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/locks.ts", + "line": 174, + "character": 6, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/lib/locks.ts#L174" + } + ], "signatures": [ { "id": 571, @@ -38940,9 +45579,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38959,9 +45598,9 @@ "name": "R" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -38970,45 +45609,41 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [ - 1280, 1270, 1337, 1328, 1413, 1320, 1364, 1391, 1312, 1290, 1401, 1300, 1, 78, 556 + 1285, 1275, 1342, 1333, 1418, 1325, 1369, 1396, 1317, 1295, 1406, 1305, 1, 78, 556 ] }, { "title": "Interfaces", - "kind": 256, "children": [ - 724, 787, 740, 1004, 1152, 1103, 1243, 715, 800, 755, 748, 781, 728, 752, 942, 934, 950 + 724, 787, 740, 1009, 1157, 1108, 1248, 715, 800, 755, 748, 781, 728, 752, 947, 939, 955 ] }, { "title": "Type Aliases", - "kind": 4194304, "children": [ - 574, 573, 861, 1136, 1127, 1149, 1140, 1069, 1212, 1059, 1196, 1092, 1080, 1060, 1046, 639, - 612, 625, 654, 667, 1091, 1165, 954, 914, 915, 998, 988, 1007, 1021, 1008, 1028, 993, 982, - 584, 1162, 1224, 1239, 575, 1042, 1038, 1029, 1191, 1186, 1030, 1033, 953, 682, 1179, 1172, - 572, 1229, 955, 695, 808, 874, 862, 831, 844, 969, 1183, 1251, 814, 884, 897, 1159, 704, - 933, 608, 606, 932 + 574, 573, 863, 1141, 1132, 1154, 1145, 1074, 1217, 1064, 1201, 1097, 1085, 1065, 1051, 639, + 612, 625, 654, 667, 1096, 1170, 959, 919, 920, 1003, 993, 1012, 1026, 1013, 1033, 998, 987, + 584, 1167, 1229, 1244, 575, 1047, 1043, 1034, 1196, 1191, 1035, 1038, 958, 682, 1184, 1177, + 572, 1234, 960, 695, 810, 876, 864, 833, 846, 974, 1188, 1256, 816, 886, 902, 1164, 704, + 938, 608, 606, 937 ] }, { "title": "Variables", - "kind": 32, - "children": [546, 547, 1250, 561] + "children": [546, 547, 1255, 561] }, { "title": "Functions", - "kind": 64, - "children": [1255, 1252, 1261, 1264, 1258, 1267, 548, 564] + "children": [1260, 1257, 1266, 1269, 1263, 1272, 548, 564] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/auth-js/blob/91474d6/src/index.ts#L1" } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json index ee5fdca66da38..5fd8b758eedd5 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 687, + "id": 683, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 688, + "id": 684, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -25,38 +25,39 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ], "signatures": [ { - "id": 689, + "id": 685, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 690, + "id": 686, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 691, + "id": 687, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 692, + "id": 688, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -73,7 +74,7 @@ ], "parameters": [ { - "id": 693, + "id": 689, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -81,14 +82,14 @@ "type": { "type": "reflection", "declaration": { - "id": 694, + "id": 690, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 699, + "id": 695, "name": "body", "kind": 1024, "kindString": "Property", @@ -99,7 +100,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -108,7 +110,7 @@ } }, { - "id": 702, + "id": 698, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -119,27 +121,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 703, + "id": 699, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 704, + "id": 700, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 705, + "id": 701, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -149,21 +159,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 706, + "id": 702, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -172,9 +182,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -183,14 +193,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -198,7 +208,7 @@ } }, { - "id": 697, + "id": 693, "name": "headers", "kind": 1024, "kindString": "Property", @@ -207,18 +217,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 707, + "id": 703, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -229,7 +240,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -238,7 +250,7 @@ } }, { - "id": 695, + "id": 691, "name": "method", "kind": 1024, "kindString": "Property", @@ -247,7 +259,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -277,7 +290,7 @@ } }, { - "id": 698, + "id": 694, "name": "schema", "kind": 1024, "kindString": "Property", @@ -288,7 +301,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -297,7 +311,7 @@ } }, { - "id": 700, + "id": 696, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -308,7 +322,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -317,7 +332,7 @@ } }, { - "id": 701, + "id": 697, "name": "signal", "kind": 1024, "kindString": "Property", @@ -328,18 +343,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 696, + "id": 692, "name": "url", "kind": 1024, "kindString": "Property", @@ -348,22 +364,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [699, 702, 697, 707, 695, 698, 700, 701, 696] + "children": [695, 698, 693, 703, 691, 694, 696, 697, 692] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -372,21 +396,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -396,7 +420,7 @@ ] }, { - "id": 712, + "id": 708, "name": "body", "kind": 1024, "kindString": "Property", @@ -408,7 +432,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -417,7 +442,7 @@ } }, { - "id": 715, + "id": 711, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -428,27 +453,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 716, + "id": 712, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 717, + "id": 713, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 718, + "id": 714, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -458,21 +491,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 719, + "id": 715, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -481,9 +514,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -492,14 +525,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -507,7 +540,7 @@ } }, { - "id": 710, + "id": 706, "name": "headers", "kind": 1024, "kindString": "Property", @@ -518,18 +551,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 720, + "id": 716, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -540,7 +574,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -549,7 +584,7 @@ } }, { - "id": 708, + "id": 704, "name": "method", "kind": 1024, "kindString": "Property", @@ -560,7 +595,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -590,7 +626,7 @@ } }, { - "id": 711, + "id": 707, "name": "schema", "kind": 1024, "kindString": "Property", @@ -602,7 +638,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -611,7 +648,7 @@ } }, { - "id": 713, + "id": 709, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -622,7 +659,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -632,7 +670,7 @@ "defaultValue": "false" }, { - "id": 714, + "id": 710, "name": "signal", "kind": 1024, "kindString": "Property", @@ -644,18 +682,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 709, + "id": 705, "name": "url", "kind": 1024, "kindString": "Property", @@ -666,18 +705,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 742, + "id": 738, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -686,57 +726,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 743, + "id": 739, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 744, + "id": 740, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 749, + "id": 745, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 741, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 742, "name": "merge", "kind": 1024, "kindString": "Property", @@ -747,7 +824,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -759,8 +837,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [746] + "children": [742] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -768,14 +853,14 @@ "default": { "type": "reflection", "declaration": { - "id": 747, + "id": 743, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 744, "name": "merge", "kind": 1024, "kindString": "Property", @@ -784,7 +869,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -796,8 +882,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [748] + "children": [744] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -806,11 +899,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -820,12 +913,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -850,7 +943,7 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -872,7 +965,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -880,17 +973,17 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -903,17 +996,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -925,12 +1018,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -939,7 +1032,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -949,7 +1042,7 @@ ] }, { - "id": 739, + "id": 735, "name": "returns", "kind": 2048, "kindString": "Method", @@ -958,44 +1051,68 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 241, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L241" } ], "signatures": [ { - "id": 740, + "id": 736, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 741, + "id": 737, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -1003,12 +1120,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 741, + "id": 737, "name": "NewResult" } ], @@ -1016,7 +1133,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1026,7 +1143,7 @@ ] }, { - "id": 723, + "id": 719, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -1035,22 +1152,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 724, + "id": 720, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 725, + "id": 721, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1061,7 +1184,7 @@ } }, { - "id": 726, + "id": 722, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -1074,21 +1197,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1098,7 +1221,7 @@ ] }, { - "id": 727, + "id": 723, "name": "then", "kind": 2048, "kindString": "Method", @@ -1107,19 +1230,20 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 728, + "id": 724, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 729, + "id": 725, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -1128,7 +1252,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1137,11 +1261,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1149,11 +1273,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1162,7 +1286,7 @@ } }, { - "id": 730, + "id": 726, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -1175,7 +1299,7 @@ ], "parameters": [ { - "id": 731, + "id": 727, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -1192,21 +1316,29 @@ { "type": "reflection", "declaration": { - "id": 732, + "id": 728, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 733, + "id": 729, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 734, + "id": 730, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -1215,7 +1347,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1224,11 +1356,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1236,11 +1368,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1254,7 +1386,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -1262,13 +1394,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -1280,7 +1412,7 @@ } }, { - "id": 735, + "id": 731, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -1297,21 +1429,29 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 732, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 737, + "id": 733, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 734, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -1327,7 +1467,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -1335,13 +1475,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -1361,20 +1501,20 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "implementationOf": { "type": "reference", @@ -1388,7 +1528,7 @@ } }, { - "id": 721, + "id": 717, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -1397,40 +1537,51 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 722, + "id": 718, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1438,16 +1589,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { @@ -1466,49 +1617,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [688] + "children": [684] }, { "title": "Properties", - "kind": 1024, - "children": [712, 715, 710, 720, 708, 711, 713, 714, 709] + "children": [708, 711, 706, 716, 704, 707, 709, 710, 705] }, { "title": "Methods", - "kind": 2048, - "children": [742, 739, 723, 727, 721] + "children": [738, 735, 719, 723, 717] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 750, + "id": 746, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 751, + "id": 747, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 752, + "id": 748, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -1526,7 +1675,7 @@ "extendedBy": [ { "type": "reference", - "id": 534, + "id": 530, "name": "PostgrestTransformBuilder" } ], @@ -1538,7 +1687,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1547,11 +1696,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1559,11 +1708,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1571,9 +1720,9 @@ } } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] }, @@ -1584,7 +1733,12 @@ "kindString": "Class", "flags": {}, "comment": { - "shortText": "PostgREST client." + "summary": [ + { + "kind": "text", + "text": "PostgREST client." + } + ] }, "children": [ { @@ -1596,8 +1750,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 44, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L51" } ], "signatures": [ @@ -1608,7 +1763,12 @@ "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Creates a PostgREST client." + "summary": [ + { + "kind": "text", + "text": "Creates a PostgREST client." + } + ] }, "typeParameter": [ { @@ -1623,75 +1783,86 @@ } }, { - "id": 15, + "id": 16, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 13, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 14, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 14, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [14] + "fileName": "src/PostgrestClient.ts", + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } - ] + ], + "type": { + "type": "reference", + "name": "I" + } } - } - ], - "name": "GetGenericDatabaseWithOptions" + ], + "groups": [ + { + "title": "Properties", + "children": [14] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 15, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } } } }, { - "id": 20, + "id": 17, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -1707,64 +1878,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 17, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [17] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -1778,71 +1910,32 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 19, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [19] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } }, { - "id": 23, + "id": 18, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -1857,64 +1950,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 22, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [22] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -1941,13 +1995,18 @@ ], "parameters": [ { - "id": 24, + "id": 19, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint" + "summary": [ + { + "kind": "text", + "text": "URL of the PostgREST endpoint" + } + ] }, "type": { "type": "intrinsic", @@ -1955,26 +2014,31 @@ } }, { - "id": 25, + "id": 20, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 26, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 29, + "id": 24, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1984,31 +2048,44 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 53, - "character": 6 + "line": 60, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 30, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 31, + "id": 26, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Custom fetch\n" + "summary": [ + { + "kind": "text", + "text": "Custom fetch" + } + ] }, "parameters": [ { - "id": 32, + "id": 27, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2018,21 +2095,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 33, + "id": 28, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2041,9 +2118,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2052,14 +2129,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2067,7 +2144,7 @@ } }, { - "id": 27, + "id": 22, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2075,24 +2152,30 @@ "isOptional": true }, "comment": { - "shortText": "Custom headers" + "summary": [ + { + "kind": "text", + "text": "Custom headers" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 51, - "character": 6 + "line": 58, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L58" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 28, + "id": 23, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2100,18 +2183,24 @@ "isOptional": true }, "comment": { - "shortText": "Postgres schema to switch to" + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, - "character": 6 + "line": 59, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L59" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" } } @@ -2119,8 +2208,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [29, 27, 28] + "children": [24, 22, 23] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 57, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L57" } ] } @@ -2139,17 +2235,17 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" } ], @@ -2159,7 +2255,7 @@ ] }, { - "id": 37, + "id": 32, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2169,28 +2265,36 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 32, - "character": 2 + "line": 39, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L39" } ], "type": { "type": "reflection", "declaration": { - "id": 38, + "id": 33, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 39, + "id": 34, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 40, + "id": 35, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2200,21 +2304,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 41, + "id": 36, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2223,9 +2327,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2234,14 +2338,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2249,7 +2353,7 @@ } }, { - "id": 35, + "id": 30, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2257,19 +2361,20 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 30, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L37" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 36, + "id": 31, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -2279,18 +2384,19 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 31, - "character": 2 + "line": 38, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L38" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" } }, { - "id": 34, + "id": 29, "name": "url", "kind": 1024, "kindString": "Property", @@ -2298,8 +2404,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2 + "line": 36, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L36" } ], "type": { @@ -2308,7 +2415,7 @@ } }, { - "id": 42, + "id": 37, "name": "from", "kind": 2048, "kindString": "Method", @@ -2316,23 +2423,41 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 61, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L68" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L72" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 80, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L80" } ], "signatures": [ { - "id": 43, + "id": 38, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 44, + "id": 39, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -2343,7 +2468,7 @@ } }, { - "id": 45, + "id": 40, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -2356,63 +2481,68 @@ ], "parameters": [ { - "id": 46, + "id": 41, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 44, + "id": 39, "name": "TableName" } } ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, { "type": "reference", - "id": 44, + "id": 39, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 47, + "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 48, + "id": 43, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -2421,7 +2551,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -2433,8 +2564,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [48] + "children": [43] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -2453,17 +2591,22 @@ } }, { - "id": 49, + "id": 44, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 50, + "id": 45, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -2474,7 +2617,7 @@ } }, { - "id": 51, + "id": 46, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -2487,63 +2630,68 @@ ], "parameters": [ { - "id": 52, + "id": 47, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName" } } ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 53, + "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 49, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -2552,7 +2700,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -2564,8 +2713,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54] + "children": [49] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -2586,7 +2742,7 @@ ] }, { - "id": 59, + "id": 54, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2594,23 +2750,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 127, - "character": 2 + "line": 134, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L134" } ], "signatures": [ { - "id": 60, + "id": 55, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 61, + "id": 56, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2621,7 +2783,7 @@ } }, { - "id": 62, + "id": 57, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -2634,28 +2796,38 @@ ], "parameters": [ { - "id": 63, + "id": 58, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 61, + "id": 56, "name": "FnName" } }, { - "id": 64, + "id": 59, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -2665,33 +2837,38 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 65, + "id": 60, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 66, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 69, + "id": 64, "name": "count", "kind": 1024, "kindString": "Property", @@ -2699,13 +2876,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 137, - "character": 6 + "line": 144, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L144" } ], "type": { @@ -2727,7 +2942,7 @@ } }, { - "id": 68, + "id": 63, "name": "get", "kind": 1024, "kindString": "Property", @@ -2735,13 +2950,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 136, - "character": 6 + "line": 143, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L143" } ], "type": { @@ -2750,7 +2979,7 @@ } }, { - "id": 67, + "id": 62, "name": "head", "kind": 1024, "kindString": "Property", @@ -2758,13 +2987,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 135, - "character": 6 + "line": 142, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L142" } ], "type": { @@ -2776,8 +3027,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [69, 68, 67] + "children": [64, 63, 62] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 141, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L141" } ] } @@ -2787,16 +3045,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { @@ -2809,7 +3067,7 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, @@ -2852,9 +3110,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -2885,13 +3143,13 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, { "type": "reference", - "id": 61, + "id": 56, "name": "FnName" }, { @@ -2909,7 +3167,7 @@ ] }, { - "id": 55, + "id": 50, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2917,24 +3175,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 89, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L96" } ], "signatures": [ { - "id": 56, + "id": 51, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 57, + "id": 52, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2947,17 +3210,22 @@ ], "parameters": [ { - "id": 58, + "id": 53, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" } } @@ -2973,12 +3241,12 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, { @@ -2987,7 +3255,7 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, "objectType": { @@ -3026,36 +3294,39 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [10] }, { "title": "Properties", - "kind": 1024, - "children": [37, 35, 36, 34] + "children": [32, 30, 31, 29] }, { "title": "Methods", - "kind": 2048, - "children": [42, 59, 55] + "children": [37, 54, 50] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 15, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L15" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 70, + "id": 65, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + "summary": [ + { + "kind": "text", + "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" + } + ] }, "default": { "type": "intrinsic", @@ -3063,117 +3334,145 @@ } }, { - "id": 73, + "id": 69, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 66, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 67, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 72, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [72] - } - ], "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 4 + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } - ] + ], + "type": { + "type": "inferred", + "name": "I", + "constraint": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" + } + } } - } - ], - "name": "GetGenericDatabaseWithOptions" - } - } - }, - { - "id": 74, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", + ], + "groups": [ + { + "title": "Properties", + "children": [67] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 68, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 21, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L21" + } + ] + } + } + } + }, + { + "id": 70, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" + }, + { + "kind": "code", + "text": "`\"public\"`" + }, + { + "kind": "text", + "text": ", this must be supplied manually." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -3188,23 +3487,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { @@ -3222,23 +3519,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -3246,7 +3541,7 @@ } }, { - "id": 75, + "id": 71, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -3261,27 +3556,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -3292,27 +3585,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "falseType": { @@ -3324,18 +3615,28 @@ ] }, { - "id": 753, + "id": 749, "name": "PostgrestError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, "children": [ { - "id": 754, + "id": 750, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -3344,19 +3645,20 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "signatures": [ { - "id": 755, + "id": 751, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 756, + "id": 752, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -3364,14 +3666,14 @@ "type": { "type": "reflection", "declaration": { - "id": 757, + "id": 753, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 757, "name": "code", "kind": 1024, "kindString": "Property", @@ -3380,7 +3682,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 73 + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3389,7 +3692,7 @@ } }, { - "id": 759, + "id": 755, "name": "details", "kind": 1024, "kindString": "Property", @@ -3398,7 +3701,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3407,7 +3711,7 @@ } }, { - "id": 760, + "id": 756, "name": "hint", "kind": 1024, "kindString": "Property", @@ -3416,7 +3720,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3425,7 +3730,7 @@ } }, { - "id": 758, + "id": 754, "name": "message", "kind": 1024, "kindString": "Property", @@ -3434,7 +3739,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3446,8 +3752,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ] } @@ -3456,7 +3769,7 @@ ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" }, "overwrites": { @@ -3471,7 +3784,7 @@ } }, { - "id": 764, + "id": 760, "name": "code", "kind": 1024, "kindString": "Property", @@ -3480,7 +3793,8 @@ { "fileName": "src/PostgrestError.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" } ], "type": { @@ -3489,7 +3803,7 @@ } }, { - "id": 762, + "id": 758, "name": "details", "kind": 1024, "kindString": "Property", @@ -3498,7 +3812,8 @@ { "fileName": "src/PostgrestError.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" } ], "type": { @@ -3507,7 +3822,7 @@ } }, { - "id": 763, + "id": 759, "name": "hint", "kind": 1024, "kindString": "Property", @@ -3516,7 +3831,8 @@ { "fileName": "src/PostgrestError.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } ], "type": { @@ -3528,66 +3844,73 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [754] + "children": [750] }, { "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "children": [760, 758, 759] } ], "sources": [ { "fileName": "src/PostgrestError.ts", "line": 6, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ] }, { - "id": 165, + "id": 161, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 166, + "id": 162, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" + } + ], "signatures": [ { - "id": 167, + "id": 163, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 168, + "id": 164, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 169, + "id": 165, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -3598,7 +3921,7 @@ } }, { - "id": 170, + "id": 166, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -3615,20 +3938,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 171, + "id": 167, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 172, + "id": 168, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -3639,7 +3962,7 @@ } }, { - "id": 173, + "id": 169, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -3650,7 +3973,7 @@ } }, { - "id": 174, + "id": 170, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -3663,7 +3986,7 @@ ], "parameters": [ { - "id": 175, + "id": 171, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -3671,14 +3994,14 @@ "type": { "type": "reflection", "declaration": { - "id": 176, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 181, + "id": 177, "name": "body", "kind": 1024, "kindString": "Property", @@ -3689,7 +4012,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -3698,7 +4022,7 @@ } }, { - "id": 184, + "id": 180, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -3709,27 +4033,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 186, + "id": 182, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 183, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3739,21 +4071,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 188, + "id": 184, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3762,9 +4094,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3773,14 +4105,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3788,7 +4120,7 @@ } }, { - "id": 179, + "id": 175, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3797,18 +4129,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 189, + "id": 185, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -3819,7 +4152,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -3828,7 +4162,7 @@ } }, { - "id": 177, + "id": 173, "name": "method", "kind": 1024, "kindString": "Property", @@ -3837,7 +4171,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -3867,7 +4202,7 @@ } }, { - "id": 180, + "id": 176, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3878,7 +4213,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -3887,7 +4223,7 @@ } }, { - "id": 182, + "id": 178, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -3898,7 +4234,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -3907,7 +4244,7 @@ } }, { - "id": 183, + "id": 179, "name": "signal", "kind": 1024, "kindString": "Property", @@ -3918,18 +4255,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 178, + "id": 174, "name": "url", "kind": 1024, "kindString": "Property", @@ -3938,22 +4276,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [181, 184, 179, 189, 177, 180, 182, 183, 178] + "children": [177, 180, 175, 185, 173, 176, 178, 179, 174] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -3962,41 +4308,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4004,19 +4350,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 536, + "id": 532, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 535, + "id": 531, "name": "default.constructor" } }, { - "id": 492, + "id": 488, "name": "body", "kind": 1024, "kindString": "Property", @@ -4028,7 +4374,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -4037,12 +4384,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 645, + "id": 641, "name": "default.body" } }, { - "id": 495, + "id": 491, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4053,27 +4400,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 496, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 497, + "id": 493, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 494, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4083,21 +4438,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 499, + "id": 495, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4106,9 +4461,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4117,14 +4472,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4132,12 +4487,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 648, + "id": 644, "name": "default.fetch" } }, { - "id": 490, + "id": 486, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4148,23 +4503,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 643, + "id": 639, "name": "default.headers" } }, { - "id": 500, + "id": 496, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -4175,7 +4531,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -4184,12 +4541,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 653, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 488, + "id": 484, "name": "method", "kind": 1024, "kindString": "Property", @@ -4200,7 +4557,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -4230,12 +4588,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 637, "name": "default.method" } }, { - "id": 491, + "id": 487, "name": "schema", "kind": 1024, "kindString": "Property", @@ -4247,7 +4605,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -4256,12 +4615,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 644, + "id": 640, "name": "default.schema" } }, { - "id": 493, + "id": 489, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -4272,7 +4631,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -4282,12 +4642,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 646, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 494, + "id": 490, "name": "signal", "kind": 1024, "kindString": "Property", @@ -4299,23 +4659,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 647, + "id": 643, "name": "default.signal" } }, { - "id": 489, + "id": 485, "name": "url", "kind": 1024, "kindString": "Property", @@ -4326,23 +4687,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 642, + "id": 638, "name": "default.url" } }, { - "id": 457, + "id": 453, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -4351,74 +4713,85 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 195, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" } ], "signatures": [ { - "id": 458, + "id": 454, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] }, "parameters": [ { - "id": 459, + "id": 455, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] }, "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4426,19 +4799,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 607, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 606, "name": "default.abortSignal" } }, { - "id": 301, + "id": 297, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -4447,22 +4820,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 354, - "character": 2 - } + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L354" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 358, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L358" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 366, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L366" + } ], "signatures": [ { - "id": 302, + "id": 298, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 303, + "id": 299, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4475,28 +4882,38 @@ ], "parameters": [ { - "id": 304, + "id": 300, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName" } }, { - "id": 305, + "id": 301, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4517,9 +4934,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -4530,12 +4947,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -4547,41 +4964,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4589,23 +5006,49 @@ } }, { - "id": 306, + "id": 302, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 307, + "id": 303, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -4613,13 +5056,18 @@ } }, { - "id": 308, + "id": 304, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4651,9 +5099,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -4661,41 +5109,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4705,7 +5153,7 @@ ] }, { - "id": 293, + "id": 289, "name": "contains", "kind": 2048, "kindString": "Method", @@ -4714,22 +5162,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L327" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L331" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 339, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L339" } ], "signatures": [ { - "id": 294, + "id": 290, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 295, + "id": 291, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4742,28 +5224,38 @@ ], "parameters": [ { - "id": 296, + "id": 292, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName" } }, { - "id": 297, + "id": 293, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4784,9 +5276,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -4797,12 +5289,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -4814,41 +5306,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4856,23 +5348,49 @@ } }, { - "id": 298, + "id": 294, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 299, + "id": 295, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -4880,13 +5398,18 @@ } }, { - "id": 300, + "id": 296, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4918,9 +5441,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -4928,41 +5451,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4972,7 +5495,7 @@ ] }, { - "id": 466, + "id": 462, "name": "csv", "kind": 2048, "kindString": "Method", @@ -4981,26 +5504,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 237, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" } ], "signatures": [ { - "id": 467, + "id": 463, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5016,19 +5553,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 616, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 619, + "id": 615, "name": "default.csv" } }, { - "id": 190, + "id": 186, "name": "eq", "kind": 2048, "kindString": "Method", @@ -5037,23 +5574,60 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L99" } ], "signatures": [ { - "id": 191, + "id": 187, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nTo check if the value of " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL, you should use " + }, + { + "kind": "code", + "text": "`.is()`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "typeParameter": [ { - "id": 192, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5066,28 +5640,38 @@ ], "parameters": [ { - "id": 193, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } }, { - "id": 194, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -5096,17 +5680,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -5127,17 +5711,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -5155,9 +5739,9 @@ "name": "ResolvedFilterValue" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, "falseType": { "type": "intrinsic", @@ -5169,41 +5753,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5213,7 +5797,7 @@ ] }, { - "id": 470, + "id": 466, "name": "explain", "kind": 2048, "kindString": "Method", @@ -5222,42 +5806,60 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 275, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" } ], "signatures": [ { - "id": 471, + "id": 467, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." + } + ] }, "parameters": [ { - "id": 472, + "id": 468, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 473, + "id": 469, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 474, + "id": 470, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -5265,13 +5867,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 283, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { @@ -5280,7 +5896,7 @@ } }, { - "id": 477, + "id": 473, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -5288,13 +5904,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 286, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -5303,7 +5933,7 @@ } }, { - "id": 479, + "id": 475, "name": "format", "kind": 1024, "kindString": "Property", @@ -5311,13 +5941,31 @@ "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 288, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -5335,7 +5983,7 @@ } }, { - "id": 476, + "id": 472, "name": "settings", "kind": 1024, "kindString": "Property", @@ -5343,13 +5991,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 285, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" } ], "type": { @@ -5358,7 +6020,7 @@ } }, { - "id": 475, + "id": 471, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -5366,13 +6028,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 284, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { @@ -5381,7 +6065,7 @@ } }, { - "id": 478, + "id": 474, "name": "wal", "kind": 1024, "kindString": "Property", @@ -5389,13 +6073,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on WAL record generation\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { @@ -5407,8 +6105,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [474, 477, 479, 476, 475, 478] + "children": [470, 473, 475, 472, 471, 474] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" } ] } @@ -5421,11 +6126,11 @@ "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5441,11 +6146,11 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5462,9 +6167,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { @@ -5478,19 +6183,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 620, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 623, + "id": 619, "name": "default.explain" } }, { - "id": 396, + "id": 392, "name": "filter", "kind": 2048, "kindString": "Method", @@ -5499,23 +6204,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 581, - "character": 2 - } - ], - "signatures": [ + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L581" + }, { - "id": 397, + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 586, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L586" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 600, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L600" + } + ], + "signatures": [ + { + "id": 393, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 398, + "id": 394, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5528,28 +6266,38 @@ ], "parameters": [ { - "id": 399, + "id": 395, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 398, + "id": 394, "name": "ColumnName" } }, { - "id": 400, + "id": 396, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "union", @@ -5650,13 +6398,18 @@ } }, { - "id": 401, + "id": 397, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5666,41 +6419,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5708,24 +6461,49 @@ } }, { - "id": 402, + "id": 398, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 403, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -5733,13 +6511,18 @@ } }, { - "id": 404, + "id": 400, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5747,13 +6530,18 @@ } }, { - "id": 405, + "id": 401, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5763,41 +6551,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5807,7 +6595,7 @@ ] }, { - "id": 468, + "id": 464, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -5816,26 +6604,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 245, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" } ], "signatures": [ { - "id": 469, + "id": 465, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5850,9 +6652,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "literal", @@ -5863,19 +6665,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 618, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 621, + "id": 617, "name": "default.geojson" } }, { - "id": 200, + "id": 196, "name": "gt", "kind": 2048, "kindString": "Method", @@ -5884,22 +6686,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 132, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L132" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 133, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L133" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L140" } ], "signatures": [ { - "id": 201, + "id": 197, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 202, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5912,39 +6748,49 @@ ], "parameters": [ { - "id": 203, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName" } }, { - "id": 204, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -5952,41 +6798,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5994,23 +6840,49 @@ } }, { - "id": 205, + "id": 201, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 206, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6018,13 +6890,18 @@ } }, { - "id": 207, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -6034,41 +6911,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6078,7 +6955,7 @@ ] }, { - "id": 208, + "id": 204, "name": "gte", "kind": 2048, "kindString": "Method", @@ -6087,22 +6964,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 145, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L145" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L146" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 153, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L153" } ], "signatures": [ { - "id": 209, + "id": 205, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 210, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6115,39 +7026,49 @@ ], "parameters": [ { - "id": 211, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName" } }, { - "id": 212, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -6155,41 +7076,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6197,23 +7118,49 @@ } }, { - "id": 213, + "id": 209, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 214, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6221,13 +7168,18 @@ } }, { - "id": 215, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -6237,41 +7189,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6281,7 +7233,7 @@ ] }, { - "id": 256, + "id": 252, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -6290,22 +7242,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 229, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L229" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 230, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L230" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 237, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L237" } ], "signatures": [ { - "id": 257, + "id": 253, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 258, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6318,28 +7304,38 @@ ], "parameters": [ { - "id": 259, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 258, + "id": 254, "name": "ColumnName" } }, { - "id": 260, + "id": 256, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -6349,41 +7345,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6391,23 +7387,49 @@ } }, { - "id": 261, + "id": 257, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "parameters": [ - { - "id": 262, - "name": "column", - "kind": 32768, - "kindString": "Parameter", + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] + }, + "parameters": [ + { + "id": 258, + "name": "column", + "kind": 32768, + "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6415,13 +7437,18 @@ } }, { - "id": 263, + "id": 259, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -6431,41 +7458,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6475,7 +7502,7 @@ ] }, { - "id": 264, + "id": 260, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", @@ -6484,22 +7511,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 242, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L242" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L246" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 253, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L253" } ], "signatures": [ { - "id": 265, + "id": 261, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 266, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6512,28 +7573,38 @@ ], "parameters": [ { - "id": 267, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 266, + "id": 262, "name": "ColumnName" } }, { - "id": 268, + "id": 264, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6550,41 +7621,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6592,23 +7663,49 @@ } }, { - "id": 269, + "id": 265, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 270, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6616,13 +7713,18 @@ } }, { - "id": 271, + "id": 267, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6639,41 +7741,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6683,7 +7785,7 @@ ] }, { - "id": 272, + "id": 268, "name": "ilikeAnyOf", "kind": 2048, "kindString": "Method", @@ -6692,22 +7794,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 258, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L258" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 262, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L262" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 269, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L269" } ], "signatures": [ { - "id": 273, + "id": 269, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 274, + "id": 270, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6720,28 +7856,38 @@ ], "parameters": [ { - "id": 275, + "id": 271, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 274, + "id": 270, "name": "ColumnName" } }, { - "id": 276, + "id": 272, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6758,41 +7904,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6800,23 +7946,49 @@ } }, { - "id": 277, + "id": 273, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 278, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6824,13 +7996,18 @@ } }, { - "id": 279, + "id": 275, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6847,41 +8024,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6891,7 +8068,7 @@ ] }, { - "id": 288, + "id": 284, "name": "in", "kind": 2048, "kindString": "Method", @@ -6900,22 +8077,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L302" } ], "signatures": [ { - "id": 289, + "id": 285, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is included in the " + }, + { + "kind": "code", + "text": "`values`" + }, + { + "kind": "text", + "text": " array." + } + ] }, "typeParameter": [ { - "id": 290, + "id": 286, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6928,28 +8127,38 @@ ], "parameters": [ { - "id": 291, + "id": 287, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } }, { - "id": 292, + "id": 288, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The values array to filter with" + } + ] }, "type": { "type": "typeOperator", @@ -6963,17 +8172,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -6994,17 +8203,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -7030,41 +8239,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7074,7 +8283,7 @@ ] }, { - "id": 280, + "id": 276, "name": "is", "kind": 2048, "kindString": "Method", @@ -7083,23 +8292,112 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 274, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L274" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 278, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L278" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 291, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L291" } ], "signatures": [ { - "id": 281, + "id": 277, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 282, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7112,139 +8410,82 @@ ], "parameters": [ { - "id": 283, + "id": 279, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 282, + "id": 278, "name": "ColumnName" } }, { - "id": 284, + "id": 280, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": null - } - ] - }, + "summary": [ { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": false - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": true - } - ] + "kind": "text", + "text": "The value to filter with" } ] + }, + "type": { + "type": "intrinsic", + "name": "Object" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7252,24 +8493,105 @@ } }, { - "id": 285, + "id": 281, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 286, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7277,13 +8599,18 @@ } }, { - "id": 287, + "id": 283, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "union", @@ -7302,41 +8629,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7346,7 +8673,7 @@ ] }, { - "id": 232, + "id": 228, "name": "like", "kind": 2048, "kindString": "Method", @@ -7355,22 +8682,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 184, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L184" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 185, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L185" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 192, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L192" } ], "signatures": [ { - "id": 233, + "id": 229, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 234, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7383,28 +8744,38 @@ ], "parameters": [ { - "id": 235, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 234, + "id": 230, "name": "ColumnName" } }, { - "id": 236, + "id": 232, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -7414,41 +8785,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7456,23 +8827,49 @@ } }, { - "id": 237, + "id": 233, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 238, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7480,13 +8877,18 @@ } }, { - "id": 239, + "id": 235, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -7496,41 +8898,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7540,7 +8942,7 @@ ] }, { - "id": 240, + "id": 236, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -7549,22 +8951,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 197, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L197" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 201, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L201" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 208, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L208" } ], "signatures": [ { - "id": 241, + "id": 237, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 242, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7577,28 +9013,38 @@ ], "parameters": [ { - "id": 243, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 242, + "id": 238, "name": "ColumnName" } }, { - "id": 244, + "id": 240, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7615,41 +9061,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7657,23 +9103,49 @@ } }, { - "id": 245, + "id": 241, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 246, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7681,13 +9153,18 @@ } }, { - "id": 247, + "id": 243, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7704,41 +9181,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7748,7 +9225,7 @@ ] }, { - "id": 248, + "id": 244, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -7757,22 +9234,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L213" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 217, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 224, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L224" } ], "signatures": [ { - "id": 249, + "id": 245, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 250, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7785,28 +9296,38 @@ ], "parameters": [ { - "id": 251, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 250, + "id": 246, "name": "ColumnName" } }, { - "id": 252, + "id": 248, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7823,41 +9344,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7865,23 +9386,49 @@ } }, { - "id": 253, + "id": 249, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 254, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7889,13 +9436,18 @@ } }, { - "id": 255, + "id": 251, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7912,41 +9464,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7956,7 +9508,7 @@ ] }, { - "id": 442, + "id": 438, "name": "limit", "kind": 2048, "kindString": "Method", @@ -7965,28 +9517,47 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" } ], "signatures": [ { - "id": 443, + "id": 439, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 444, + "id": 440, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows to return" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] }, "type": { "type": "intrinsic", @@ -7994,26 +9565,31 @@ } }, { - "id": 445, + "id": 441, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 442, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 443, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8021,13 +9597,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -8036,7 +9626,7 @@ } }, { - "id": 448, + "id": 444, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8044,13 +9634,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -8062,8 +9658,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [447, 448] + "children": [443, 444] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } @@ -8073,41 +9676,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8115,19 +9718,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 596, + "id": 592, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 595, + "id": 591, "name": "default.limit" } }, { - "id": 216, + "id": 212, "name": "lt", "kind": 2048, "kindString": "Method", @@ -8136,22 +9739,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 158, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L158" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 159, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L159" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 166, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L166" } ], "signatures": [ { - "id": 217, + "id": 213, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 218, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8164,39 +9801,49 @@ ], "parameters": [ { - "id": 219, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName" } }, { - "id": 220, + "id": 216, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -8204,41 +9851,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8246,23 +9893,49 @@ } }, { - "id": 221, + "id": 217, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 222, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -8270,13 +9943,18 @@ } }, { - "id": 223, + "id": 219, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -8286,41 +9964,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8330,7 +10008,7 @@ ] }, { - "id": 224, + "id": 220, "name": "lte", "kind": 2048, "kindString": "Method", @@ -8339,22 +10017,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L171" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 172, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L172" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 179, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L179" } ], "signatures": [ { - "id": 225, + "id": 221, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 226, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8367,39 +10079,49 @@ ], "parameters": [ { - "id": 227, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName" } }, { - "id": 228, + "id": 224, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -8407,41 +10129,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8449,23 +10171,49 @@ } }, { - "id": 229, + "id": 225, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 230, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -8473,13 +10221,18 @@ } }, { - "id": 231, + "id": 227, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -8489,41 +10242,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8533,7 +10286,7 @@ ] }, { - "id": 373, + "id": 369, "name": "match", "kind": 2048, "kindString": "Method", @@ -8542,22 +10295,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 514, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L514" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 515, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L515" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 523, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L523" } ], "signatures": [ { - "id": 374, + "id": 370, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "typeParameter": [ { - "id": 375, + "id": 371, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8570,79 +10357,84 @@ ], "parameters": [ { - "id": 376, + "id": 372, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8650,23 +10442,49 @@ } }, { - "id": 377, + "id": 373, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "parameters": [ { - "id": 378, + "id": 374, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", @@ -8680,49 +10498,49 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8732,7 +10550,7 @@ ] }, { - "id": 485, + "id": 481, "name": "maxAffected", "kind": 2048, "kindString": "Method", @@ -8741,28 +10559,39 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], "signatures": [ { - "id": 486, + "id": 482, "name": "maxAffected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] }, "parameters": [ { - "id": 487, + "id": 483, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" + } + ] }, "type": { "type": "intrinsic", @@ -8783,7 +10612,7 @@ }, "objectType": { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" } } @@ -8798,7 +10627,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 174, + "id": 170, "name": "Method" }, "extendsType": { @@ -8820,41 +10649,41 @@ }, "trueType": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8884,19 +10713,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 639, + "id": 635, "name": "default.maxAffected" } } ], "inheritedFrom": { "type": "reference", - "id": 638, + "id": 634, "name": "default.maxAffected" } }, { - "id": 463, + "id": 459, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -8905,23 +10734,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 220, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], "signatures": [ { - "id": 464, + "id": 460, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, "typeParameter": [ { - "id": 465, + "id": 461, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -8930,7 +10780,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, "extendsType": { @@ -8953,11 +10803,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -8969,7 +10819,7 @@ }, { "type": "reference", - "id": 465, + "id": 461, "name": "ResultOne" } ] @@ -8983,19 +10833,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 613, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 612, "name": "default.maybeSingle" } }, { - "id": 195, + "id": 191, "name": "neq", "kind": 2048, "kindString": "Method", @@ -9004,22 +10854,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 120, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L120" } ], "signatures": [ { - "id": 196, + "id": 192, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is not equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 197, + "id": 193, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9032,28 +10904,38 @@ ], "parameters": [ { - "id": 198, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } }, { - "id": 199, + "id": 195, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -9062,17 +10944,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -9093,17 +10975,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -9127,41 +11009,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9171,7 +11053,7 @@ ] }, { - "id": 379, + "id": 375, "name": "not", "kind": 2048, "kindString": "Method", @@ -9180,23 +11062,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 530, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L530" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 535, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L535" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 549, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L549" } ], "signatures": [ { - "id": 380, + "id": 376, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 381, + "id": 377, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9209,28 +11124,38 @@ ], "parameters": [ { - "id": 382, + "id": 378, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName" } }, { - "id": 383, + "id": 379, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "reference", @@ -9238,24 +11163,29 @@ } }, { - "id": 384, + "id": 380, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -9263,41 +11193,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9305,24 +11235,49 @@ } }, { - "id": 385, + "id": 381, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 386, + "id": 382, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -9330,13 +11285,18 @@ } }, { - "id": 387, + "id": 383, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9344,13 +11304,18 @@ } }, { - "id": 388, + "id": 384, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9360,41 +11325,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9404,7 +11369,7 @@ ] }, { - "id": 389, + "id": 385, "name": "or", "kind": 2048, "kindString": "Method", @@ -9413,29 +11378,55 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 569, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L569" } ], "signatures": [ { - "id": 390, + "id": 386, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`filters`" + }, + { + "kind": "text", + "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " + }, + { + "kind": "code", + "text": "`.or()`" + }, + { + "kind": "text", + "text": " filter across multiple tables." + } + ] }, "parameters": [ { - "id": 391, + "id": 387, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The filters to use, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9443,26 +11434,31 @@ } }, { - "id": 392, + "id": 388, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 390, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -9470,13 +11466,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `referencedTable` instead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`referencedTable`" + }, + { + "kind": "text", + "text": " instead" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -9485,7 +11495,7 @@ } }, { - "id": 395, + "id": 391, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9493,13 +11503,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to filter on referenced tables\ninstead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to filter on referenced tables\ninstead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -9511,8 +11527,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [394, 395] + "children": [390, 391] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 574, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ] } @@ -9522,41 +11545,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9566,7 +11589,7 @@ ] }, { - "id": 411, + "id": 407, "name": "order", "kind": 2048, "kindString": "Method", @@ -9575,23 +11598,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 412, + "id": 408, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "typeParameter": [ { - "id": 413, + "id": 409, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9604,22 +11672,27 @@ ], "parameters": [ { - "id": 414, + "id": 410, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "id": 413, + "id": 409, "name": "ColumnName" } }, { - "id": 415, + "id": 411, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9627,19 +11700,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 416, + "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 413, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -9647,13 +11725,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9662,7 +11754,7 @@ } }, { - "id": 418, + "id": 414, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -9670,13 +11762,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9685,7 +11815,7 @@ } }, { - "id": 419, + "id": 415, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9693,13 +11823,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9711,8 +11847,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [417, 418, 419] + "children": [413, 414, 415] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ] } @@ -9721,41 +11864,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9763,29 +11906,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 561, "name": "default.order" } }, { - "id": 420, + "id": 416, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "parameters": [ { - "id": 421, + "id": 417, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "intrinsic", @@ -9793,7 +11961,7 @@ } }, { - "id": 422, + "id": 418, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9801,19 +11969,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 419, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 420, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -9821,13 +11994,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9836,7 +12023,7 @@ } }, { - "id": 425, + "id": 421, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -9844,13 +12031,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9859,7 +12084,7 @@ } }, { - "id": 426, + "id": 422, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9867,13 +12092,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9885,8 +12116,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [424, 425, 426] + "children": [420, 421, 422] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ] } @@ -9895,41 +12133,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9937,29 +12175,45 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 569, "name": "default.order" } }, { - "id": 427, + "id": 423, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "typeParameter": [ { - "id": 428, + "id": 424, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9972,42 +12226,36 @@ ], "parameters": [ { - "id": 429, + "id": 425, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "reference", - "id": 428, + "id": 424, "name": "ColumnName" } }, { - "id": 430, + "id": 426, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 431, + "id": 427, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 432, + "id": 428, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -10018,7 +12266,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10027,7 +12276,7 @@ } }, { - "id": 434, + "id": 430, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10038,7 +12287,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10047,7 +12297,7 @@ } }, { - "id": 433, + "id": 429, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -10058,7 +12308,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10070,8 +12321,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [432, 434, 433] + "children": [428, 430, 429] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ] } @@ -10080,41 +12338,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10122,63 +12380,73 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 576, "name": "default.order" } }, { - "id": 435, + "id": 431, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "parameters": [ { - "id": 436, + "id": 432, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 437, + "id": 433, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 438, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 439, + "id": 435, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -10189,7 +12457,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10198,7 +12467,7 @@ } }, { - "id": 441, + "id": 437, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10209,7 +12478,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10218,7 +12488,7 @@ } }, { - "id": 440, + "id": 436, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -10229,7 +12499,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10241,8 +12512,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 441, 440] + "children": [435, 437, 436] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } @@ -10251,41 +12529,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10293,19 +12571,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 588, + "id": 584, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 560, "name": "default.order" } }, { - "id": 349, + "id": 345, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -10314,22 +12592,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 453, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L453" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 457, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L457" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 465, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L465" } ], "signatures": [ { - "id": 350, + "id": 346, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "typeParameter": [ { - "id": 351, + "id": 347, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -10342,28 +12654,38 @@ ], "parameters": [ { - "id": 352, + "id": 348, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName" } }, { - "id": 353, + "id": 349, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -10381,12 +12703,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -10398,41 +12720,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10440,23 +12762,49 @@ } }, { - "id": 354, + "id": 350, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "parameters": [ { - "id": 355, + "id": 351, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -10464,13 +12812,18 @@ } }, { - "id": 356, + "id": 352, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -10496,41 +12849,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10540,7 +12893,7 @@ ] }, { - "id": 519, + "id": 515, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -10549,57 +12902,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 520, + "id": 516, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 521, + "id": 517, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 526, + "id": 522, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 522, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 519, "name": "merge", "kind": 1024, "kindString": "Property", @@ -10610,7 +13000,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -10622,8 +13013,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [523] + "children": [519] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -10631,14 +13029,14 @@ "default": { "type": "reflection", "declaration": { - "id": 524, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 521, "name": "merge", "kind": 1024, "kindString": "Property", @@ -10647,7 +13045,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -10659,8 +13058,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [521] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -10669,11 +13075,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -10683,12 +13089,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -10713,7 +13119,7 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -10735,7 +13141,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -10743,17 +13149,17 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -10766,17 +13172,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -10788,12 +13194,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -10809,19 +13215,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 673, + "id": 669, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", - "id": 672, + "id": 668, "name": "default.overrideTypes" } }, { - "id": 449, + "id": 445, "name": "range", "kind": 2048, "kindString": "Method", @@ -10830,28 +13236,79 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 173, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" } ], "signatures": [ { - "id": 450, + "id": 446, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] }, "parameters": [ { - "id": 451, + "id": 447, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -10859,13 +13316,18 @@ } }, { - "id": 452, + "id": 448, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -10873,26 +13335,31 @@ } }, { - "id": 453, + "id": 449, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 454, + "id": 450, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 455, + "id": 451, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10900,13 +13367,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -10915,7 +13396,7 @@ } }, { - "id": 456, + "id": 452, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -10923,13 +13404,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -10941,8 +13428,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [455, 456] + "children": [451, 452] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ] } @@ -10952,41 +13446,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10994,19 +13488,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 603, + "id": 599, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 602, + "id": 598, "name": "default.range" } }, { - "id": 341, + "id": 337, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -11015,22 +13509,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 438, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L438" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 439, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L439" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 448, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L448" } ], "signatures": [ { - "id": 342, + "id": 338, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] }, "typeParameter": [ { - "id": 343, + "id": 339, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11043,28 +13571,38 @@ ], "parameters": [ { - "id": 344, + "id": 340, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 343, + "id": 339, "name": "ColumnName" } }, { - "id": 345, + "id": 341, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11074,41 +13612,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11116,23 +13654,49 @@ } }, { - "id": 346, + "id": 342, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] }, "parameters": [ { - "id": 347, + "id": 343, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11140,13 +13704,18 @@ } }, { - "id": 348, + "id": 344, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11156,41 +13725,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11200,7 +13769,7 @@ ] }, { - "id": 309, + "id": 305, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -11209,22 +13778,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 380, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L380" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 381, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L381" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L389" } ], "signatures": [ { - "id": 310, + "id": 306, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 311, + "id": 307, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11237,28 +13840,38 @@ ], "parameters": [ { - "id": 312, + "id": 308, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 311, + "id": 307, "name": "ColumnName" } }, { - "id": 313, + "id": 309, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11268,41 +13881,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11310,23 +13923,49 @@ } }, { - "id": 314, + "id": 310, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 315, + "id": 311, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11334,13 +13973,18 @@ } }, { - "id": 316, + "id": 312, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11350,41 +13994,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11394,7 +14038,7 @@ ] }, { - "id": 317, + "id": 313, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -11403,22 +14047,64 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 394, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L394" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 395, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L395" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 404, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L404" } ], "signatures": [ { - "id": 318, + "id": 314, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 319, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11431,28 +14117,38 @@ ], "parameters": [ { - "id": 320, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 319, + "id": 315, "name": "ColumnName" } }, { - "id": 321, + "id": 317, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11462,41 +14158,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11504,23 +14200,57 @@ } }, { - "id": 322, + "id": 318, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 323, + "id": 319, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11528,13 +14258,18 @@ } }, { - "id": 324, + "id": 320, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11544,41 +14279,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11588,7 +14323,7 @@ ] }, { - "id": 325, + "id": 321, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -11597,22 +14332,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 409, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L409" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 410, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L410" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 418, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L418" } ], "signatures": [ { - "id": 326, + "id": 322, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 327, + "id": 323, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11625,28 +14394,38 @@ ], "parameters": [ { - "id": 328, + "id": 324, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 327, + "id": 323, "name": "ColumnName" } }, { - "id": 329, + "id": 325, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11656,41 +14435,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11698,23 +14477,49 @@ } }, { - "id": 330, + "id": 326, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 331, + "id": 327, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11722,13 +14527,18 @@ } }, { - "id": 332, + "id": 328, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11738,41 +14548,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11782,7 +14592,7 @@ ] }, { - "id": 333, + "id": 329, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -11791,22 +14601,64 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 423, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L423" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 424, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L424" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 433, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L433" } ], "signatures": [ { - "id": 334, + "id": 330, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 335, + "id": 331, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11819,28 +14671,38 @@ ], "parameters": [ { - "id": 336, + "id": 332, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 335, + "id": 331, "name": "ColumnName" } }, { - "id": 337, + "id": 333, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11850,41 +14712,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11892,23 +14754,57 @@ } }, { - "id": 338, + "id": 334, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 339, + "id": 335, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11916,13 +14812,18 @@ } }, { - "id": 340, + "id": 336, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11932,41 +14833,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11976,7 +14877,7 @@ ] }, { - "id": 482, + "id": 478, "name": "returns", "kind": 2048, "kindString": "Method", @@ -11985,54 +14886,78 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" } ], "signatures": [ { - "id": 483, + "id": 479, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 484, + "id": 480, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { @@ -12040,12 +14965,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 484, + "id": 480, "name": "NewResult" } ], @@ -12053,17 +14978,17 @@ }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12071,19 +14996,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 636, + "id": 632, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 635, + "id": 631, "name": "default.returns" } }, { - "id": 480, + "id": 476, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -12092,57 +15017,70 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" } ], "signatures": [ { - "id": 481, + "id": 477, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will still be returned, but the query is not committed." + } + ] }, "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12150,19 +15088,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 634, + "id": 630, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 633, + "id": 629, "name": "default.rollback" } }, { - "id": 406, + "id": 402, "name": "select", "kind": 2048, "kindString": "Method", @@ -12171,23 +15109,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" } ], "signatures": [ { - "id": 407, + "id": 403, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 408, + "id": 404, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -12202,43 +15185,43 @@ } }, { - "id": 409, + "id": 405, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 408, + "id": 404, "name": "Query" }, { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" } ], @@ -12248,7 +15231,7 @@ ], "parameters": [ { - "id": 410, + "id": 406, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -12256,55 +15239,60 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] }, "type": { "type": "reference", - "id": 408, + "id": 404, "name": "Query" } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 409, + "id": 405, "name": "NewResultOne" } }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12312,19 +15300,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 560, + "id": 556, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 559, + "id": 555, "name": "default.select" } }, { - "id": 503, + "id": 499, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -12333,22 +15321,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 504, + "id": 500, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 505, + "id": 501, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -12359,7 +15353,7 @@ } }, { - "id": 506, + "id": 502, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -12372,41 +15366,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12414,19 +15408,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 657, + "id": 653, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 656, + "id": 652, "name": "default.setHeader" } }, { - "id": 460, + "id": 456, "name": "single", "kind": 2048, "kindString": "Method", @@ -12435,23 +15429,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 206, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" } ], "signatures": [ { - "id": 461, + "id": 457, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise this\nreturns an error." + } + ] }, "typeParameter": [ { - "id": 462, + "id": 458, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -12460,7 +15475,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, "extendsType": { @@ -12483,16 +15498,16 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 462, + "id": 458, "name": "ResultOne" }, { @@ -12504,19 +15519,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 614, + "id": 610, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 613, + "id": 609, "name": "default.single" } }, { - "id": 357, + "id": 353, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -12525,22 +15540,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 476, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L476" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 481, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L481" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 496, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L496" } ], "signatures": [ { - "id": 358, + "id": 354, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 359, + "id": 355, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -12553,28 +15602,38 @@ ], "parameters": [ { - "id": 360, + "id": 356, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The text or tsvector column to filter on" + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] }, "type": { "type": "reference", - "id": 359, + "id": 355, "name": "ColumnName" } }, { - "id": 361, + "id": 357, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The query text to match with" + "summary": [ + { + "kind": "text", + "text": "The query text to match with" + } + ] }, "type": { "type": "intrinsic", @@ -12582,7 +15641,7 @@ } }, { - "id": 362, + "id": 358, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12590,19 +15649,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 364, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -12610,13 +15674,19 @@ "isOptional": true }, "comment": { - "shortText": "The text search configuration to use" + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 479, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ], "type": { @@ -12625,7 +15695,7 @@ } }, { - "id": 365, + "id": 361, "name": "type", "kind": 1024, "kindString": "Property", @@ -12633,13 +15703,27 @@ "isOptional": true }, "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 479, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ], "type": { @@ -12664,8 +15748,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [364, 365] + "children": [360, 361] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ] } @@ -12674,41 +15765,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12716,23 +15807,49 @@ } }, { - "id": 366, + "id": 362, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 367, + "id": 363, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The text or tsvector column to filter on" + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -12740,13 +15857,18 @@ } }, { - "id": 368, + "id": 364, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The query text to match with" + "summary": [ + { + "kind": "text", + "text": "The query text to match with" + } + ] }, "type": { "type": "intrinsic", @@ -12754,7 +15876,7 @@ } }, { - "id": 369, + "id": 365, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12762,19 +15884,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 370, + "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 371, + "id": 367, "name": "config", "kind": 1024, "kindString": "Property", @@ -12782,13 +15909,19 @@ "isOptional": true }, "comment": { - "shortText": "The text search configuration to use" + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 484, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ], "type": { @@ -12797,7 +15930,7 @@ } }, { - "id": 372, + "id": 368, "name": "type", "kind": 1024, "kindString": "Property", @@ -12805,13 +15938,27 @@ "isOptional": true }, "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 484, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ], "type": { @@ -12836,8 +15983,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [371, 372] + "children": [367, 368] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 484, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ] } @@ -12846,41 +16000,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12890,7 +16044,7 @@ ] }, { - "id": 507, + "id": 503, "name": "then", "kind": 2048, "kindString": "Method", @@ -12899,30 +16053,31 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 508, + "id": 504, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 509, + "id": 505, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -12930,7 +16085,7 @@ } }, { - "id": 510, + "id": 506, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -12943,7 +16098,7 @@ ], "parameters": [ { - "id": 511, + "id": 507, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -12960,32 +16115,40 @@ { "type": "reflection", "declaration": { - "id": 512, + "id": 508, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 513, + "id": 509, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 514, + "id": 510, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -12998,7 +16161,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -13006,13 +16169,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -13024,7 +16187,7 @@ } }, { - "id": 515, + "id": 511, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -13041,21 +16204,29 @@ { "type": "reflection", "declaration": { - "id": 516, + "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 517, + "id": 513, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 518, + "id": 514, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -13071,7 +16242,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -13079,13 +16250,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -13105,36 +16276,36 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 661, + "id": 657, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 660, + "id": 656, "name": "default.then" } }, { - "id": 501, + "id": 497, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -13143,60 +16314,71 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 502, + "id": 498, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -13204,16 +16386,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { @@ -13227,14 +16409,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 655, + "id": 651, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 654, + "id": 650, "name": "default.throwOnError" } } @@ -13242,21 +16424,18 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [166] + "children": [162] }, { "title": "Properties", - "kind": 1024, - "children": [492, 495, 490, 500, 488, 491, 493, 494, 489] + "children": [488, 491, 486, 496, 484, 487, 489, 490, 485] }, { "title": "Methods", - "kind": 2048, "children": [ - 457, 301, 293, 466, 190, 470, 396, 468, 200, 208, 256, 264, 272, 288, 280, 232, 240, - 248, 442, 216, 224, 373, 485, 463, 195, 379, 389, 411, 349, 519, 449, 341, 309, 317, - 325, 333, 482, 480, 406, 503, 460, 357, 507, 501 + 453, 297, 289, 462, 186, 466, 392, 464, 196, 204, 252, 260, 268, 284, 276, 228, 236, + 244, 438, 212, 220, 369, 481, 459, 191, 375, 385, 407, 345, 515, 445, 337, 305, 313, + 321, 329, 478, 476, 402, 499, 456, 353, 503, 497 ] } ], @@ -13264,24 +16443,25 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 74, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L74" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 527, + "id": 523, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 528, + "id": 524, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13292,7 +16472,7 @@ } }, { - "id": 529, + "id": 525, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -13309,20 +16489,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 530, + "id": 526, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 531, + "id": 527, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13333,7 +16513,7 @@ } }, { - "id": 532, + "id": 528, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13344,7 +16524,7 @@ } }, { - "id": 533, + "id": 529, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -13358,41 +16538,41 @@ "extendedTypes": [ { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -13401,14 +16581,14 @@ ] }, { - "id": 76, + "id": 72, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 77, + "id": 73, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -13417,31 +16597,32 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L18" } ], "signatures": [ { - "id": 78, + "id": 74, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 79, + "id": 75, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 80, + "id": 76, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13452,7 +16633,7 @@ } }, { - "id": 81, + "id": 77, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -13472,7 +16653,7 @@ } }, { - "id": 82, + "id": 78, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13483,7 +16664,7 @@ } }, { - "id": 85, + "id": 81, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13492,20 +16673,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 83, + "id": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 80, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -13514,7 +16695,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -13526,8 +16708,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [84] + "children": [80] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -13545,20 +16734,20 @@ ], "parameters": [ { - "id": 86, + "id": 82, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 87, + "id": 83, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -13566,14 +16755,14 @@ "type": { "type": "reflection", "declaration": { - "id": 88, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 91, + "id": 87, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13584,27 +16773,35 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 27, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L27" } ], "type": { "type": "reflection", "declaration": { - "id": 92, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 93, + "id": 89, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 94, + "id": 90, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13614,21 +16811,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 95, + "id": 91, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13637,9 +16834,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -13648,14 +16845,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13663,7 +16860,7 @@ } }, { - "id": 89, + "id": 85, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13674,18 +16871,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 25, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L25" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 90, + "id": 86, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13696,7 +16894,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 26, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L26" } ], "type": { @@ -13708,8 +16907,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [91, 89, 90] + "children": [87, 85, 86] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 24, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L24" } ] } @@ -13718,31 +16924,31 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" } ], @@ -13752,7 +16958,7 @@ ] }, { - "id": 100, + "id": 96, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13763,27 +16969,35 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 102, + "id": 98, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 103, + "id": 99, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13793,21 +17007,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 104, + "id": 100, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13816,9 +17030,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -13827,14 +17041,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13842,7 +17056,7 @@ } }, { - "id": 97, + "id": 93, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13851,18 +17065,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L13" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 98, + "id": 94, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13873,7 +17088,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L14" } ], "type": { @@ -13882,7 +17098,7 @@ } }, { - "id": 99, + "id": 95, "name": "signal", "kind": 1024, "kindString": "Property", @@ -13893,18 +17109,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 15, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L15" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 96, + "id": 92, "name": "url", "kind": 1024, "kindString": "Property", @@ -13913,18 +17130,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L12" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 153, + "id": 149, "name": "delete", "kind": 2048, "kindString": "Method", @@ -13933,42 +17151,60 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L411" } ], "signatures": [ { - "id": 154, + "id": 150, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": " after filters." + } + ] }, "parameters": [ { - "id": 155, + "id": 151, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 156, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 157, + "id": 153, "name": "count", "kind": 1024, "kindString": "Property", @@ -13976,13 +17212,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count deleted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 414, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L414" } ], "type": { @@ -14007,8 +17281,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [157] + "children": [153] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 413, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L413" } ] } @@ -14018,16 +17299,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14038,7 +17319,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14048,12 +17329,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14067,7 +17348,7 @@ ] }, { - "id": 114, + "id": 110, "name": "insert", "kind": 2048, "kindString": "Method", @@ -14076,23 +17357,48 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 116, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L116" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 130, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L130" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 171, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L171" } ], "signatures": [ { - "id": 115, + "id": 111, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 116, + "id": 112, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14109,30 +17415,35 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 117, + "id": 113, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] }, "type": { "type": "reference", - "id": 116, + "id": 112, "name": "Row" } }, { - "id": 118, + "id": 114, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14140,19 +17451,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 119, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 120, + "id": 116, "name": "count", "kind": 1024, "kindString": "Property", @@ -14160,13 +17476,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 119, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L119" } ], "type": { @@ -14191,8 +17545,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [120] + "children": [116] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 118, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L118" } ] } @@ -14201,16 +17562,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14221,7 +17582,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14231,12 +17592,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14248,18 +17609,30 @@ } }, { - "id": 121, + "id": 117, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 122, + "id": 118, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14276,33 +17649,38 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 123, + "id": 119, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", - "id": 122, + "id": 118, "name": "Row" } } }, { - "id": 124, + "id": 120, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14310,19 +17688,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 125, + "id": 121, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 126, + "id": 122, "name": "count", "kind": 1024, "kindString": "Property", @@ -14330,13 +17713,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 133, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L133" } ], "type": { @@ -14358,7 +17779,7 @@ } }, { - "id": 127, + "id": 123, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -14366,13 +17787,27 @@ "isOptional": true }, "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. Only applies for bulk\ninserts.\n" + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 134, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L134" } ], "type": { @@ -14384,8 +17819,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [126, 127] + "children": [122, 123] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 132, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L132" } ] } @@ -14394,16 +17836,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14414,7 +17856,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14424,12 +17866,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14443,7 +17885,7 @@ ] }, { - "id": 105, + "id": 101, "name": "select", "kind": 2048, "kindString": "Method", @@ -14452,22 +17894,28 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L57" } ], "signatures": [ { - "id": 106, + "id": 102, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT query on the table or view." + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT query on the table or view." + } + ] }, "typeParameter": [ { - "id": 107, + "id": 103, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -14482,18 +17930,18 @@ } }, { - "id": 108, + "id": 104, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14504,28 +17952,28 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "reference", - "id": 107, + "id": 103, "name": "Query" }, { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" } ], @@ -14535,7 +17983,7 @@ ], "parameters": [ { - "id": 109, + "id": 105, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -14543,35 +17991,49 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " + }, + { + "kind": "code", + "text": "`customName:columnName`" + } + ] }, "type": { "type": "reference", - "id": 107, + "id": 103, "name": "Query" } }, { - "id": 110, + "id": 106, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 111, + "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 113, + "id": 109, "name": "count", "kind": 1024, "kindString": "Property", @@ -14579,13 +18041,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows in the table or view.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 74, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L74" } ], "type": { @@ -14607,7 +18107,7 @@ } }, { - "id": 112, + "id": 108, "name": "head", "kind": 1024, "kindString": "Property", @@ -14615,13 +18115,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 73, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L73" } ], "type": { @@ -14633,8 +18155,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [113, 112] + "children": [109, 108] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 72, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L72" } ] } @@ -14644,16 +18173,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14664,7 +18193,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14672,18 +18201,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 108, + "id": 104, "name": "ResultOne" } }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14697,7 +18226,7 @@ ] }, { - "id": 146, + "id": 142, "name": "update", "kind": 2048, "kindString": "Method", @@ -14706,23 +18235,36 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L361" } ], "signatures": [ { - "id": 147, + "id": 143, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": " after filters." + } + ] }, "typeParameter": [ { - "id": 148, + "id": 144, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14739,49 +18281,59 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 149, + "id": 145, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update with\n" + "summary": [ + { + "kind": "text", + "text": "The values to update with" + } + ] }, "type": { "type": "reference", - "id": 148, + "id": 144, "name": "Row" } }, { - "id": 150, + "id": 146, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 147, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 148, "name": "count", "kind": 1024, "kindString": "Property", @@ -14789,13 +18341,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count updated rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 366, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L366" } ], "type": { @@ -14820,8 +18410,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152] + "children": [148] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 365, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L365" } ] } @@ -14831,16 +18428,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14851,7 +18448,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14861,12 +18458,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14880,7 +18477,7 @@ ] }, { - "id": 128, + "id": 124, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -14889,23 +18486,88 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 233, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L233" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 288, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L288" } ], "signatures": [ { - "id": 129, + "id": 125, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 130, + "id": 126, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14922,30 +18584,35 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 131, + "id": 127, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { "type": "reference", - "id": 130, + "id": 126, "name": "Row" } }, { - "id": 132, + "id": 128, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14953,19 +18620,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, + "id": 132, "name": "count", "kind": 1024, "kindString": "Property", @@ -14973,13 +18645,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 222, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L222" } ], "type": { @@ -14998,24 +18708,46 @@ "value": "estimated" } ] - } - }, - { - "id": 135, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + } + }, + { + "id": 131, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 221, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L221" } ], "type": { @@ -15024,7 +18756,7 @@ } }, { - "id": 134, + "id": 130, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -15032,13 +18764,27 @@ "isOptional": true }, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + "summary": [ + { + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns are equal." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 220, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L220" } ], "type": { @@ -15050,8 +18796,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [136, 135, 134] + "children": [132, 131, 130] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 219, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L219" } ] } @@ -15060,16 +18813,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -15080,7 +18833,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -15090,12 +18843,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -15107,18 +18860,70 @@ } }, { - "id": 137, + "id": 133, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 138, + "id": 134, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15135,33 +18940,38 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 139, + "id": 135, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", - "id": 138, + "id": 134, "name": "Row" } } }, { - "id": 140, + "id": 136, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15169,19 +18979,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 141, + "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 144, + "id": 140, "name": "count", "kind": 1024, "kindString": "Property", @@ -15189,13 +19004,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 238, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L238" } ], "type": { @@ -15217,7 +19070,7 @@ } }, { - "id": 145, + "id": 141, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -15225,13 +19078,35 @@ "isOptional": true }, "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`. This also only applies when doing bulk upserts.\n" + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates: false`" + }, + { + "kind": "text", + "text": ". This also only applies when doing bulk upserts." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 239, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L239" } ], "type": { @@ -15240,7 +19115,7 @@ } }, { - "id": 143, + "id": 139, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -15248,13 +19123,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 237, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L237" } ], "type": { @@ -15263,7 +19160,7 @@ } }, { - "id": 142, + "id": 138, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -15271,13 +19168,27 @@ "isOptional": true }, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + "summary": [ + { + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns are equal." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 236, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L236" } ], "type": { @@ -15289,8 +19200,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [144, 145, 143, 142] + "children": [140, 141, 139, 138] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 235, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L235" } ] } @@ -15299,16 +19217,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -15319,7 +19237,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -15329,12 +19247,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -15351,42 +19269,40 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [77] + "children": [73] }, { "title": "Properties", - "kind": 1024, - "children": [100, 97, 98, 99, 96] + "children": [96, 93, 94, 95, 92] }, { "title": "Methods", - "kind": 2048, - "children": [153, 114, 105, 146, 128] + "children": [149, 110, 101, 142, 124] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 5, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L5" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 158, + "id": 154, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 159, + "id": 155, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15397,7 +19313,7 @@ } }, { - "id": 160, + "id": 156, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -15417,7 +19333,7 @@ } }, { - "id": 161, + "id": 157, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15428,7 +19344,7 @@ } }, { - "id": 164, + "id": 160, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15437,20 +19353,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 162, + "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 163, + "id": 159, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -15459,7 +19375,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -15471,15 +19388,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [163] + "children": [159] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -15497,40 +19414,48 @@ ] }, { - "id": 534, + "id": 530, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 535, + "id": 531, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" + } + ], "signatures": [ { - "id": 536, + "id": 532, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 537, + "id": 533, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 538, + "id": 534, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15541,7 +19466,7 @@ } }, { - "id": 539, + "id": 535, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15558,20 +19483,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 540, + "id": 536, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 541, + "id": 537, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15582,7 +19507,7 @@ } }, { - "id": 542, + "id": 538, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15593,7 +19518,7 @@ } }, { - "id": 543, + "id": 539, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -15606,7 +19531,7 @@ ], "parameters": [ { - "id": 544, + "id": 540, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -15614,14 +19539,14 @@ "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 546, "name": "body", "kind": 1024, "kindString": "Property", @@ -15632,7 +19557,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -15641,7 +19567,7 @@ } }, { - "id": 553, + "id": 549, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -15652,27 +19578,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 555, + "id": 551, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 552, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -15682,21 +19616,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 557, + "id": 553, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -15705,9 +19639,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -15716,14 +19650,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15731,7 +19665,7 @@ } }, { - "id": 548, + "id": 544, "name": "headers", "kind": 1024, "kindString": "Property", @@ -15740,18 +19674,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 558, + "id": 554, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -15762,7 +19697,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -15771,7 +19707,7 @@ } }, { - "id": 546, + "id": 542, "name": "method", "kind": 1024, "kindString": "Property", @@ -15780,7 +19716,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -15810,7 +19747,7 @@ } }, { - "id": 549, + "id": 545, "name": "schema", "kind": 1024, "kindString": "Property", @@ -15821,7 +19758,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -15830,7 +19768,7 @@ } }, { - "id": 551, + "id": 547, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -15841,7 +19779,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -15850,7 +19789,7 @@ } }, { - "id": 552, + "id": 548, "name": "signal", "kind": 1024, "kindString": "Property", @@ -15861,18 +19800,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 547, + "id": 543, "name": "url", "kind": 1024, "kindString": "Property", @@ -15881,22 +19821,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [550, 553, 548, 558, 546, 549, 551, 552, 547] + "children": [546, 549, 544, 554, 542, 545, 547, 548, 543] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -15905,41 +19853,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -15947,19 +19895,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 689, + "id": 685, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 688, + "id": 684, "name": "default.constructor" } }, { - "id": 645, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -15971,7 +19919,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -15980,12 +19929,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 712, + "id": 708, "name": "default.body" } }, { - "id": 648, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -15996,27 +19945,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 649, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 650, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -16026,21 +19983,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 652, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -16049,9 +20006,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -16060,14 +20017,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16075,12 +20032,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 715, + "id": 711, "name": "default.fetch" } }, { - "id": 643, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -16091,23 +20048,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 710, + "id": 706, "name": "default.headers" } }, { - "id": 653, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -16118,7 +20076,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -16127,12 +20086,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 720, + "id": 716, "name": "default.isMaybeSingle" } }, { - "id": 641, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -16143,7 +20102,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -16173,12 +20133,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 708, + "id": 704, "name": "default.method" } }, { - "id": 644, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -16190,7 +20150,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -16199,12 +20160,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 711, + "id": 707, "name": "default.schema" } }, { - "id": 646, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -16215,7 +20176,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -16225,12 +20187,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 713, + "id": 709, "name": "default.shouldThrowOnError" } }, { - "id": 647, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -16242,23 +20204,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 714, + "id": 710, "name": "default.signal" } }, { - "id": 642, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -16269,23 +20232,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 709, + "id": 705, "name": "default.url" } }, { - "id": 610, + "id": 606, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -16294,74 +20258,85 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 195, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" } ], "signatures": [ { - "id": 611, + "id": 607, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] }, "parameters": [ { - "id": 612, + "id": 608, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] }, "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -16371,7 +20346,7 @@ ] }, { - "id": 619, + "id": 615, "name": "csv", "kind": 2048, "kindString": "Method", @@ -16380,26 +20355,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 237, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" } ], "signatures": [ { - "id": 620, + "id": 616, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16417,7 +20406,7 @@ ] }, { - "id": 623, + "id": 619, "name": "explain", "kind": 2048, "kindString": "Method", @@ -16426,42 +20415,60 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 275, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" } ], "signatures": [ { - "id": 624, + "id": 620, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." + } + ] }, "parameters": [ { - "id": 625, + "id": 621, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 626, + "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 627, + "id": 623, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -16469,13 +20476,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 283, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { @@ -16484,7 +20505,7 @@ } }, { - "id": 630, + "id": 626, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -16492,13 +20513,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 286, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -16507,7 +20542,7 @@ } }, { - "id": 632, + "id": 628, "name": "format", "kind": 1024, "kindString": "Property", @@ -16515,13 +20550,31 @@ "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 288, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -16539,7 +20592,7 @@ } }, { - "id": 629, + "id": 625, "name": "settings", "kind": 1024, "kindString": "Property", @@ -16547,13 +20600,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 285, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" } ], "type": { @@ -16562,7 +20629,7 @@ } }, { - "id": 628, + "id": 624, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -16570,13 +20637,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 284, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { @@ -16585,7 +20674,7 @@ } }, { - "id": 631, + "id": 627, "name": "wal", "kind": 1024, "kindString": "Property", @@ -16593,13 +20682,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on WAL record generation\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { @@ -16611,8 +20714,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [627, 630, 632, 629, 628, 631] + "children": [623, 626, 628, 625, 624, 627] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" } ] } @@ -16625,11 +20735,11 @@ "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16645,11 +20755,11 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16666,9 +20776,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { @@ -16684,7 +20794,7 @@ ] }, { - "id": 621, + "id": 617, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -16693,26 +20803,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 245, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" } ], "signatures": [ { - "id": 622, + "id": 618, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16727,9 +20851,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "literal", @@ -16742,7 +20866,7 @@ ] }, { - "id": 595, + "id": 591, "name": "limit", "kind": 2048, "kindString": "Method", @@ -16751,28 +20875,47 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" } ], "signatures": [ { - "id": 596, + "id": 592, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 597, + "id": 593, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows to return" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] }, "type": { "type": "intrinsic", @@ -16780,26 +20923,31 @@ } }, { - "id": 598, + "id": 594, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 599, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, + "id": 596, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -16807,13 +20955,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -16822,7 +20984,7 @@ } }, { - "id": 601, + "id": 597, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -16830,13 +20992,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -16848,8 +21016,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [600, 601] + "children": [596, 597] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } @@ -16859,41 +21034,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -16903,7 +21078,7 @@ ] }, { - "id": 638, + "id": 634, "name": "maxAffected", "kind": 2048, "kindString": "Method", @@ -16912,28 +21087,39 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], "signatures": [ { - "id": 639, + "id": 635, "name": "maxAffected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] }, "parameters": [ { - "id": 640, + "id": 636, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" + } + ] }, "type": { "type": "intrinsic", @@ -16954,7 +21140,7 @@ }, "objectType": { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" } } @@ -16969,7 +21155,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 543, + "id": 539, "name": "Method" }, "extendsType": { @@ -16991,41 +21177,41 @@ }, "trueType": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17057,7 +21243,7 @@ ] }, { - "id": 616, + "id": 612, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -17066,23 +21252,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 220, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], "signatures": [ { - "id": 617, + "id": 613, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, "typeParameter": [ { - "id": 618, + "id": 614, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -17091,7 +21298,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, "extendsType": { @@ -17114,11 +21321,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -17130,7 +21337,7 @@ }, { "type": "reference", - "id": 465, + "id": 461, "name": "ResultOne" } ] @@ -17146,7 +21353,7 @@ ] }, { - "id": 564, + "id": 560, "name": "order", "kind": 2048, "kindString": "Method", @@ -17155,23 +21362,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 565, + "id": 561, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "typeParameter": [ { - "id": 566, + "id": 562, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -17184,22 +21436,27 @@ ], "parameters": [ { - "id": 567, + "id": 563, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "id": 413, + "id": 409, "name": "ColumnName" } }, { - "id": 568, + "id": 564, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -17207,19 +21464,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 565, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 570, + "id": 566, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17227,13 +21489,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17242,7 +21518,7 @@ } }, { - "id": 571, + "id": 567, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17250,13 +21526,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17265,7 +21579,7 @@ } }, { - "id": 572, + "id": 568, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -17273,13 +21587,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17291,8 +21611,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [570, 571, 572] + "children": [566, 567, 568] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ] } @@ -17301,41 +21628,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17343,24 +21670,49 @@ } }, { - "id": 573, + "id": 569, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "parameters": [ { - "id": 574, + "id": 570, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "intrinsic", @@ -17368,7 +21720,7 @@ } }, { - "id": 575, + "id": 571, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -17376,19 +21728,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 576, + "id": 572, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 573, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17396,13 +21753,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17411,7 +21782,7 @@ } }, { - "id": 578, + "id": 574, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17419,13 +21790,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17434,7 +21843,7 @@ } }, { - "id": 579, + "id": 575, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -17442,13 +21851,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17460,8 +21875,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [577, 578, 579] + "children": [573, 574, 575] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ] } @@ -17470,41 +21892,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17512,24 +21934,40 @@ } }, { - "id": 580, + "id": 576, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "typeParameter": [ { - "id": 581, + "id": 577, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -17542,42 +21980,36 @@ ], "parameters": [ { - "id": 582, + "id": 578, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "reference", - "id": 428, + "id": 424, "name": "ColumnName" } }, { - "id": 583, + "id": 579, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 584, + "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 585, + "id": 581, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17588,7 +22020,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17597,7 +22030,7 @@ } }, { - "id": 587, + "id": 583, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -17608,7 +22041,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17617,7 +22051,7 @@ } }, { - "id": 586, + "id": 582, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17628,7 +22062,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17640,8 +22075,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [585, 587, 586] + "children": [581, 583, 582] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ] } @@ -17650,41 +22092,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17692,58 +22134,68 @@ } }, { - "id": 588, + "id": 584, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "parameters": [ { - "id": 589, + "id": 585, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 590, + "id": 586, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 591, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 592, + "id": 588, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17754,7 +22206,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17763,7 +22216,7 @@ } }, { - "id": 594, + "id": 590, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -17774,7 +22227,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17783,7 +22237,7 @@ } }, { - "id": 593, + "id": 589, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17794,7 +22248,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17806,8 +22261,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [592, 594, 593] + "children": [588, 590, 589] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } @@ -17816,41 +22278,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17860,7 +22322,7 @@ ] }, { - "id": 672, + "id": 668, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -17869,57 +22331,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 673, + "id": 669, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 674, + "id": 670, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 679, + "id": 675, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 675, + "id": 671, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 676, + "id": 672, "name": "merge", "kind": 1024, "kindString": "Property", @@ -17930,7 +22429,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -17942,8 +22442,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [676] + "children": [672] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -17951,14 +22458,14 @@ "default": { "type": "reflection", "declaration": { - "id": 677, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 678, + "id": 674, "name": "merge", "kind": 1024, "kindString": "Property", @@ -17967,7 +22474,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -17979,8 +22487,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [678] + "children": [674] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -17989,11 +22504,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -18003,12 +22518,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -18033,7 +22548,7 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18055,7 +22570,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -18063,17 +22578,17 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -18086,17 +22601,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -18108,12 +22623,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -18129,19 +22644,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 743, + "id": 739, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", - "id": 742, + "id": 738, "name": "default.overrideTypes" } }, { - "id": 602, + "id": 598, "name": "range", "kind": 2048, "kindString": "Method", @@ -18150,28 +22665,79 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 173, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" } ], "signatures": [ { - "id": 603, + "id": 599, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] }, "parameters": [ { - "id": 604, + "id": 600, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -18179,13 +22745,18 @@ } }, { - "id": 605, + "id": 601, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -18193,26 +22764,31 @@ } }, { - "id": 606, + "id": 602, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 607, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 608, + "id": 604, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -18220,13 +22796,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -18235,7 +22825,7 @@ } }, { - "id": 609, + "id": 605, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -18243,13 +22833,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -18261,8 +22857,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [608, 609] + "children": [604, 605] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ] } @@ -18272,41 +22875,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18316,7 +22919,7 @@ ] }, { - "id": 635, + "id": 631, "name": "returns", "kind": 2048, "kindString": "Method", @@ -18325,54 +22928,78 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" } ], "signatures": [ { - "id": 636, + "id": 632, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 637, + "id": 633, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { @@ -18380,12 +23007,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 484, + "id": 480, "name": "NewResult" } ], @@ -18393,17 +23020,17 @@ }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18411,19 +23038,19 @@ }, "overwrites": { "type": "reference", - "id": 740, + "id": 736, "name": "default.returns" } } ], "overwrites": { "type": "reference", - "id": 739, + "id": 735, "name": "default.returns" } }, { - "id": 633, + "id": 629, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -18432,57 +23059,70 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" } ], "signatures": [ { - "id": 634, + "id": 630, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will still be returned, but the query is not committed." + } + ] }, "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18492,7 +23132,7 @@ ] }, { - "id": 559, + "id": 555, "name": "select", "kind": 2048, "kindString": "Method", @@ -18501,23 +23141,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" } ], "signatures": [ { - "id": 560, + "id": 556, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 561, + "id": 557, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -18532,43 +23217,43 @@ } }, { - "id": 562, + "id": 558, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 408, + "id": 404, "name": "Query" }, { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" } ], @@ -18578,7 +23263,7 @@ ], "parameters": [ { - "id": 563, + "id": 559, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -18586,55 +23271,60 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] }, "type": { "type": "reference", - "id": 408, + "id": 404, "name": "Query" } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 409, + "id": 405, "name": "NewResultOne" } }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18644,7 +23334,7 @@ ] }, { - "id": 656, + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -18653,22 +23343,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 657, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 658, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -18679,7 +23375,7 @@ } }, { - "id": 659, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -18692,41 +23388,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18734,19 +23430,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 724, + "id": 720, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 723, + "id": 719, "name": "default.setHeader" } }, { - "id": 613, + "id": 609, "name": "single", "kind": 2048, "kindString": "Method", @@ -18755,23 +23451,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 206, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" } ], "signatures": [ { - "id": 614, + "id": 610, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise this\nreturns an error." + } + ] }, "typeParameter": [ { - "id": 615, + "id": 611, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -18780,7 +23497,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, "extendsType": { @@ -18803,16 +23520,16 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 462, + "id": 458, "name": "ResultOne" }, { @@ -18826,7 +23543,7 @@ ] }, { - "id": 660, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -18835,30 +23552,31 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 661, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 662, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18866,7 +23584,7 @@ } }, { - "id": 663, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -18879,7 +23597,7 @@ ], "parameters": [ { - "id": 664, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -18896,32 +23614,40 @@ { "type": "reflection", "declaration": { - "id": 665, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 666, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 667, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18934,7 +23660,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -18942,13 +23668,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -18960,7 +23686,7 @@ } }, { - "id": 668, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -18977,21 +23703,29 @@ { "type": "reflection", "declaration": { - "id": 669, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 670, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -19007,7 +23741,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -19015,13 +23749,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -19041,36 +23775,36 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 728, + "id": 724, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 727, + "id": 723, "name": "default.then" } }, { - "id": 654, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -19079,60 +23813,71 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 655, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -19140,16 +23885,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { @@ -19163,14 +23908,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 722, + "id": 718, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 721, + "id": 717, "name": "default.throwOnError" } } @@ -19178,19 +23923,16 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [535] + "children": [531] }, { "title": "Properties", - "kind": 1024, - "children": [645, 648, 643, 653, 641, 644, 646, 647, 642] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", - "kind": 2048, "children": [ - 610, 619, 623, 621, 595, 638, 616, 564, 672, 602, 635, 633, 559, 656, 613, 660, 654 + 606, 615, 619, 617, 591, 634, 612, 560, 668, 598, 631, 629, 555, 652, 609, 656, 650 ] } ], @@ -19198,24 +23940,25 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 11, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L11" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 680, + "id": 676, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 681, + "id": 677, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -19226,7 +23969,7 @@ } }, { - "id": 682, + "id": 678, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -19243,20 +23986,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 683, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 684, + "id": 680, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -19267,7 +24010,7 @@ } }, { - "id": 685, + "id": 681, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -19278,7 +24021,7 @@ } }, { - "id": 686, + "id": 682, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -19292,16 +24035,16 @@ "extendedTypes": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -19311,20 +24054,20 @@ "extendedBy": [ { "type": "reference", - "id": 165, + "id": 161, "name": "PostgrestFilterBuilder" } ] }, { - "id": 767, + "id": 763, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 770, + "id": 766, "name": "count", "kind": 1024, "kindString": "Property", @@ -19333,7 +24076,8 @@ { "fileName": "src/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L24" } ], "type": { @@ -19342,7 +24086,7 @@ } }, { - "id": 769, + "id": 765, "name": "data", "kind": 1024, "kindString": "Property", @@ -19351,7 +24095,8 @@ { "fileName": "src/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L23" } ], "type": { @@ -19360,7 +24105,7 @@ } }, { - "id": 768, + "id": 764, "name": "error", "kind": 1024, "kindString": "Property", @@ -19369,17 +24114,18 @@ { "fileName": "src/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L22" } ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" } }, { - "id": 771, + "id": 767, "name": "status", "kind": 1024, "kindString": "Property", @@ -19388,7 +24134,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -19401,7 +24148,7 @@ } }, { - "id": 772, + "id": 768, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -19410,7 +24157,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -19426,15 +24174,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [770, 769, 768, 771, 772] + "children": [766, 765, 764, 767, 768] } ], "sources": [ { "fileName": "src/types.ts", "line": 21, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L21" } ], "extendedTypes": [ @@ -19445,14 +24193,14 @@ ] }, { - "id": 773, + "id": 769, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 776, + "id": 772, "name": "count", "kind": 1024, "kindString": "Property", @@ -19461,7 +24209,8 @@ { "fileName": "src/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L19" } ], "type": { @@ -19479,7 +24228,7 @@ } }, { - "id": 775, + "id": 771, "name": "data", "kind": 1024, "kindString": "Property", @@ -19488,17 +24237,18 @@ { "fileName": "src/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L18" } ], "type": { "type": "reference", - "id": 779, + "id": 775, "name": "T" } }, { - "id": 774, + "id": 770, "name": "error", "kind": 1024, "kindString": "Property", @@ -19507,7 +24257,8 @@ { "fileName": "src/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L17" } ], "type": { @@ -19516,7 +24267,7 @@ } }, { - "id": 777, + "id": 773, "name": "status", "kind": 1024, "kindString": "Property", @@ -19525,7 +24276,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -19538,7 +24290,7 @@ } }, { - "id": 778, + "id": 774, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -19547,7 +24299,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -19563,20 +24316,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [776, 775, 774, 777, 778] + "children": [772, 771, 770, 773, 774] } ], "sources": [ { "fileName": "src/types.ts", "line": 16, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 779, + "id": 775, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -19591,8 +24344,8 @@ ] }, { - "id": 784, - "name": "ClientServerOptions", + "id": 780, + "name": "PostgrestClientOptions", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -19600,20 +24353,21 @@ { "fileName": "src/types.ts", "line": 74, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" } ], "type": { "type": "reflection", "declaration": { - "id": 785, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 786, + "id": 782, "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", @@ -19624,7 +24378,8 @@ { "fileName": "src/types.ts", "line": 75, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L75" } ], "type": { @@ -19636,265 +24391,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [786] + "children": [782] } ], "sources": [ { "fileName": "src/types.ts", "line": 74, - "character": 34 + "character": 34, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" } ] } } }, { - "id": 787, - "name": "GetGenericDatabaseWithOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 85, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 788, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - }, - { - "id": 791, - "name": "Opts", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "default": { - "type": "reflection", - "declaration": { - "id": 789, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 790, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [790] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 37 - } - ] - } - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - } - ], - "name": "IsAny" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - } - ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" - } - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" - } - } - } - }, - { - "id": 782, + "id": 778, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -19903,12 +24415,13 @@ { "fileName": "src/types.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L31" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 783, + "id": 779, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -19917,14 +24430,14 @@ ], "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 783, + "id": 779, "name": "T" }, { @@ -19938,7 +24451,7 @@ } }, { - "id": 765, + "id": 761, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -19947,12 +24460,13 @@ { "fileName": "src/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L32" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 766, + "id": 762, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -19961,13 +24475,13 @@ ], "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 766, + "id": 762, "name": "T" } } @@ -19976,7 +24490,7 @@ } }, { - "id": 780, + "id": 776, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -19985,12 +24499,13 @@ { "fileName": "src/types.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L30" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 781, + "id": 777, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20002,11 +24517,11 @@ "types": [ { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 781, + "id": 777, "name": "T" } ], @@ -20014,37 +24529,48 @@ }, { "type": "reference", - "id": 767, + "id": 763, "name": "PostgrestResponseFailure" } ] } }, { - "id": 792, + "id": 783, "name": "UnstableGetResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "Main entry point for constructing the result type of a PostgREST query." + "summary": [ + { + "kind": "text", + "text": "Main entry point for constructing the result type of a PostgREST query." + } + ] }, "sources": [ { "fileName": "src/select-query-parser/result.ts", "line": 37, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/select-query-parser/result.ts#L37" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 793, + "id": 784, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Database schema." + "summary": [ + { + "kind": "text", + "text": "Database schema." + } + ] }, "type": { "type": "reference", @@ -20052,13 +24578,18 @@ } }, { - "id": 794, + "id": 785, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The type of a row in the current table." + "summary": [ + { + "kind": "text", + "text": "The type of a row in the current table." + } + ] }, "type": { "type": "reference", @@ -20072,39 +24603,54 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 795, + "id": 786, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The name of the current table or view." + "summary": [ + { + "kind": "text", + "text": "The name of the current table or view." + } + ] } }, { - "id": 796, + "id": 787, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Relationships of the current table." + "summary": [ + { + "kind": "text", + "text": "Relationships of the current table." + } + ] } }, { - "id": 797, + "id": 788, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The select query string literal to parse.\n" + "summary": [ + { + "kind": "text", + "text": "The select query string literal to parse." + } + ] }, "type": { "type": "intrinsic", @@ -20112,14 +24658,14 @@ } }, { - "id": 798, + "id": 789, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } } @@ -20131,7 +24677,7 @@ "typeArguments": [ { "type": "reference", - "id": 793, + "id": 784, "name": "Schema" } ], @@ -20148,7 +24694,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -20175,7 +24721,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -20211,7 +24757,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, "extendsType": { @@ -20225,7 +24771,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -20259,7 +24805,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -20268,7 +24814,7 @@ }, "trueType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "falseType": { @@ -20278,7 +24824,7 @@ }, { "type": "reference", - "id": 794, + "id": 785, "name": "Row" } ], @@ -20291,7 +24837,7 @@ }, "falseType": { "type": "reference", - "id": 794, + "id": 785, "name": "Row" } }, @@ -20302,7 +24848,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -20329,7 +24875,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -20340,7 +24886,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, "extendsType": { @@ -20355,27 +24901,27 @@ "typeArguments": [ { "type": "reference", - "id": 798, + "id": 789, "name": "ClientOptions" }, { "type": "reference", - "id": 793, + "id": 784, "name": "Schema" }, { "type": "reference", - "id": 794, + "id": 785, "name": "Row" }, { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, { @@ -20430,7 +24976,8 @@ { "fileName": "src/index.ts", "line": 17, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" } ], "type": { @@ -20448,11 +24995,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L22" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 687, + "id": 683, "name": "default" } } @@ -20463,6 +25018,14 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L18" + } + ], "type": { "type": "query", "queryType": { @@ -20478,11 +25041,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L23" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 753, + "id": 749, "name": "default" } } @@ -20493,11 +25064,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L20" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 165, + "id": 161, "name": "default" } } @@ -20508,11 +25087,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L19" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 76, + "id": 72, "name": "default" } } @@ -20523,11 +25110,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L21" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 534, + "id": 530, "name": "default" } } @@ -20536,9 +25131,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [7, 3, 8, 5, 4, 6] } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 15, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" + } ] } } @@ -20547,22 +25149,18 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [687, 9, 753, 165, 76, 534] + "children": [683, 9, 749, 161, 72, 530] }, { "title": "Interfaces", - "kind": 256, - "children": [767, 773] + "children": [763, 769] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [784, 787, 782, 765, 780, 792] + "children": [780, 778, 761, 776, 783] }, { "title": "Variables", - "kind": 32, "children": [1] } ], @@ -20570,7 +25168,8 @@ { "fileName": "src/index.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L2" } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index f999509259287..dbecc81a5ee6f 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 687, + "id": 683, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 688, + "id": 684, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -25,38 +25,39 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ], "signatures": [ { - "id": 689, + "id": 685, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 690, + "id": 686, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 691, + "id": 687, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 692, + "id": 688, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -73,7 +74,7 @@ ], "parameters": [ { - "id": 693, + "id": 689, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -81,14 +82,14 @@ "type": { "type": "reflection", "declaration": { - "id": 694, + "id": 690, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 699, + "id": 695, "name": "body", "kind": 1024, "kindString": "Property", @@ -99,7 +100,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -108,7 +110,7 @@ } }, { - "id": 702, + "id": 698, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -119,27 +121,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 703, + "id": 699, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 704, + "id": 700, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 705, + "id": 701, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -149,21 +159,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 706, + "id": 702, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -172,9 +182,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -183,14 +193,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -198,7 +208,7 @@ } }, { - "id": 697, + "id": 693, "name": "headers", "kind": 1024, "kindString": "Property", @@ -207,18 +217,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 707, + "id": 703, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -229,7 +240,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -238,7 +250,7 @@ } }, { - "id": 695, + "id": 691, "name": "method", "kind": 1024, "kindString": "Property", @@ -247,7 +259,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -277,7 +290,7 @@ } }, { - "id": 698, + "id": 694, "name": "schema", "kind": 1024, "kindString": "Property", @@ -288,7 +301,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -297,7 +311,7 @@ } }, { - "id": 700, + "id": 696, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -308,7 +322,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -317,7 +332,7 @@ } }, { - "id": 701, + "id": 697, "name": "signal", "kind": 1024, "kindString": "Property", @@ -328,18 +343,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 696, + "id": 692, "name": "url", "kind": 1024, "kindString": "Property", @@ -348,22 +364,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [699, 702, 697, 707, 695, 698, 700, 701, 696] + "children": [695, 698, 693, 703, 691, 694, 696, 697, 692] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -372,21 +396,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -396,7 +420,7 @@ ] }, { - "id": 712, + "id": 708, "name": "body", "kind": 1024, "kindString": "Property", @@ -408,7 +432,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -417,7 +442,7 @@ } }, { - "id": 715, + "id": 711, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -428,27 +453,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 716, + "id": 712, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 717, + "id": 713, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 718, + "id": 714, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -458,21 +491,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 719, + "id": 715, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -481,9 +514,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -492,14 +525,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -507,7 +540,7 @@ } }, { - "id": 710, + "id": 706, "name": "headers", "kind": 1024, "kindString": "Property", @@ -518,18 +551,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 720, + "id": 716, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -540,7 +574,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -549,7 +584,7 @@ } }, { - "id": 708, + "id": 704, "name": "method", "kind": 1024, "kindString": "Property", @@ -560,7 +595,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -590,7 +626,7 @@ } }, { - "id": 711, + "id": 707, "name": "schema", "kind": 1024, "kindString": "Property", @@ -602,7 +638,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -611,7 +648,7 @@ } }, { - "id": 713, + "id": 709, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -622,7 +659,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -632,7 +670,7 @@ "defaultValue": "false" }, { - "id": 714, + "id": 710, "name": "signal", "kind": 1024, "kindString": "Property", @@ -644,18 +682,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 709, + "id": 705, "name": "url", "kind": 1024, "kindString": "Property", @@ -666,18 +705,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 742, + "id": 738, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -686,57 +726,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 743, + "id": 739, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 744, + "id": 740, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 749, + "id": 745, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 745, + "id": 741, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 742, "name": "merge", "kind": 1024, "kindString": "Property", @@ -747,7 +824,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -759,8 +837,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [746] + "children": [742] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -768,14 +853,14 @@ "default": { "type": "reflection", "declaration": { - "id": 747, + "id": 743, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 748, + "id": 744, "name": "merge", "kind": 1024, "kindString": "Property", @@ -784,7 +869,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -796,8 +882,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [748] + "children": [744] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -806,11 +899,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -820,12 +913,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -850,7 +943,7 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -872,7 +965,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -880,17 +973,17 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -903,17 +996,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -925,12 +1018,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -939,7 +1032,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -949,7 +1042,7 @@ ] }, { - "id": 739, + "id": 735, "name": "returns", "kind": 2048, "kindString": "Method", @@ -958,44 +1051,68 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 241, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L241" } ], "signatures": [ { - "id": 740, + "id": 736, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 741, + "id": 737, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { @@ -1003,12 +1120,12 @@ "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 741, + "id": 737, "name": "NewResult" } ], @@ -1016,7 +1133,7 @@ }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1026,7 +1143,7 @@ ] }, { - "id": 723, + "id": 719, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -1035,22 +1152,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 724, + "id": 720, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 725, + "id": 721, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1061,7 +1184,7 @@ } }, { - "id": 726, + "id": 722, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -1074,21 +1197,21 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1098,7 +1221,7 @@ ] }, { - "id": 727, + "id": 723, "name": "then", "kind": 2048, "kindString": "Method", @@ -1107,19 +1230,20 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 728, + "id": 724, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 729, + "id": 725, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", @@ -1128,7 +1252,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1137,11 +1261,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1149,11 +1273,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1162,7 +1286,7 @@ } }, { - "id": 730, + "id": 726, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -1175,7 +1299,7 @@ ], "parameters": [ { - "id": 731, + "id": 727, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -1192,21 +1316,29 @@ { "type": "reflection", "declaration": { - "id": 732, + "id": 728, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 733, + "id": 729, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 734, + "id": 730, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -1215,7 +1347,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1224,11 +1356,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1236,11 +1368,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1254,7 +1386,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -1262,13 +1394,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -1280,7 +1412,7 @@ } }, { - "id": 735, + "id": 731, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -1297,21 +1429,29 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 732, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 737, + "id": 733, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 734, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -1327,7 +1467,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -1335,13 +1475,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -1361,20 +1501,20 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "implementationOf": { "type": "reference", @@ -1388,7 +1528,7 @@ } }, { - "id": 721, + "id": 717, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -1397,40 +1537,51 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 722, + "id": 718, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" } ], @@ -1438,16 +1589,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 690, + "id": 686, "name": "ClientOptions" }, { "type": "reference", - "id": 691, + "id": 687, "name": "Result" }, { @@ -1466,49 +1617,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [688] + "children": [684] }, { "title": "Properties", - "kind": 1024, - "children": [712, 715, 710, 720, 708, 711, 713, 714, 709] + "children": [708, 711, 706, 716, 704, 707, 709, 710, 705] }, { "title": "Methods", - "kind": 2048, - "children": [742, 739, 723, 727, 721] + "children": [738, 735, 719, 723, 717] } ], "sources": [ { "fileName": "src/PostgrestBuilder.ts", "line": 16, - "character": 30 + "character": 30, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 750, + "id": 746, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 751, + "id": 747, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 752, + "id": 748, "name": "ThrowOnError", "kind": 131072, "kindString": "Type parameter", @@ -1526,7 +1675,7 @@ "extendedBy": [ { "type": "reference", - "id": 534, + "id": 530, "name": "PostgrestTransformBuilder" } ], @@ -1538,7 +1687,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 692, + "id": 688, "name": "ThrowOnError" }, "extendsType": { @@ -1547,11 +1696,11 @@ }, "trueType": { "type": "reference", - "id": 773, + "id": 769, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1559,11 +1708,11 @@ }, "falseType": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 691, + "id": 687, "name": "Result" } ], @@ -1571,9 +1720,9 @@ } } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] }, @@ -1584,7 +1733,12 @@ "kindString": "Class", "flags": {}, "comment": { - "shortText": "PostgREST client." + "summary": [ + { + "kind": "text", + "text": "PostgREST client." + } + ] }, "children": [ { @@ -1596,8 +1750,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 44, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L51" } ], "signatures": [ @@ -1608,7 +1763,12 @@ "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Creates a PostgREST client." + "summary": [ + { + "kind": "text", + "text": "Creates a PostgREST client." + } + ] }, "typeParameter": [ { @@ -1623,75 +1783,86 @@ } }, { - "id": 15, + "id": 16, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 13, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 14, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 14, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } + "fileName": "src/PostgrestClient.ts", + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [14] - } - ] + "type": { + "type": "reference", + "name": "I" + } } - } - ], - "name": "GetGenericDatabaseWithOptions" + ], + "groups": [ + { + "title": "Properties", + "children": [14] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 15, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } } } }, { - "id": 20, + "id": 17, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -1707,64 +1878,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 17, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [17] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -1778,71 +1910,32 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 12, + "name": "Database" + } }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 19, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [19] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" + { + "type": "literal", + "value": "__InternalSupabase" } - } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } }, { - "id": 23, + "id": 18, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -1857,64 +1950,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 22, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [22] - } - ] - } - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -1941,13 +1995,18 @@ ], "parameters": [ { - "id": 24, + "id": 19, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint" + "summary": [ + { + "kind": "text", + "text": "URL of the PostgREST endpoint" + } + ] }, "type": { "type": "intrinsic", @@ -1955,26 +2014,31 @@ } }, { - "id": 25, + "id": 20, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 26, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 29, + "id": 24, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1984,31 +2048,44 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 53, - "character": 6 + "line": 60, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L60" } ], "type": { "type": "reflection", "declaration": { - "id": 30, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 31, + "id": 26, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Custom fetch\n" + "summary": [ + { + "kind": "text", + "text": "Custom fetch" + } + ] }, "parameters": [ { - "id": 32, + "id": 27, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2018,21 +2095,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 33, + "id": 28, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2041,9 +2118,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2052,14 +2129,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2067,7 +2144,7 @@ } }, { - "id": 27, + "id": 22, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2075,24 +2152,30 @@ "isOptional": true }, "comment": { - "shortText": "Custom headers" + "summary": [ + { + "kind": "text", + "text": "Custom headers" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 51, - "character": 6 + "line": 58, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L58" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 28, + "id": 23, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2100,18 +2183,24 @@ "isOptional": true }, "comment": { - "shortText": "Postgres schema to switch to" + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to" + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, - "character": 6 + "line": 59, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L59" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName", "dereferenced": {} } @@ -2120,8 +2209,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [29, 27, 28] + "children": [24, 22, 23] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 57, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L57" } ] } @@ -2140,17 +2236,17 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" } ], @@ -2160,7 +2256,7 @@ ] }, { - "id": 37, + "id": 32, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2170,28 +2266,36 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 32, - "character": 2 + "line": 39, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L39" } ], "type": { "type": "reflection", "declaration": { - "id": 38, + "id": 33, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 39, + "id": 34, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 40, + "id": 35, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2201,21 +2305,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 41, + "id": 36, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2224,9 +2328,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2235,14 +2339,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2250,7 +2354,7 @@ } }, { - "id": 35, + "id": 30, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2258,19 +2362,20 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 30, - "character": 2 + "line": 37, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L37" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 36, + "id": 31, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -2280,19 +2385,20 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 31, - "character": 2 + "line": 38, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L38" } ], "type": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName", "dereferenced": {} } }, { - "id": 34, + "id": 29, "name": "url", "kind": 1024, "kindString": "Property", @@ -2300,8 +2406,9 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2 + "line": 36, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L36" } ], "type": { @@ -2310,7 +2417,7 @@ } }, { - "id": 42, + "id": 37, "name": "from", "kind": 2048, "kindString": "Method", @@ -2318,23 +2425,41 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 61, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L68" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L72" + }, + { + "fileName": "src/PostgrestClient.ts", + "line": 80, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L80" } ], "signatures": [ { - "id": 43, + "id": 38, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 44, + "id": 39, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -2345,7 +2470,7 @@ } }, { - "id": 45, + "id": 40, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -2358,17 +2483,22 @@ ], "parameters": [ { - "id": 46, + "id": 41, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 44, + "id": 39, "name": "TableName", "dereferenced": {} } @@ -2376,46 +2506,46 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, { "type": "reference", - "id": 44, + "id": 39, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 45, + "id": 40, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 47, + "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 48, + "id": 43, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -2424,7 +2554,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -2436,8 +2567,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [48] + "children": [43] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -2456,17 +2594,22 @@ } }, { - "id": 49, + "id": 44, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 50, + "id": 45, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -2477,7 +2620,7 @@ } }, { - "id": 51, + "id": 46, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -2490,17 +2633,22 @@ ], "parameters": [ { - "id": 52, + "id": 47, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName", "dereferenced": {} } @@ -2508,46 +2656,46 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, { "type": "reference", - "id": 50, + "id": 45, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 51, + "id": 46, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 53, + "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 49, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -2556,7 +2704,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -2568,8 +2717,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54] + "children": [49] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -2590,7 +2746,7 @@ ] }, { - "id": 59, + "id": 54, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2598,23 +2754,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 127, - "character": 2 + "line": 134, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L134" } ], "signatures": [ { - "id": 60, + "id": 55, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 61, + "id": 56, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2625,7 +2787,7 @@ } }, { - "id": 62, + "id": 57, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -2638,29 +2800,39 @@ ], "parameters": [ { - "id": 63, + "id": 58, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 61, + "id": 56, "name": "FnName", "dereferenced": {} } }, { - "id": 64, + "id": 59, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -2670,33 +2842,38 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 65, + "id": 60, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 66, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 69, + "id": 64, "name": "count", "kind": 1024, "kindString": "Property", @@ -2704,13 +2881,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 137, - "character": 6 + "line": 144, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L144" } ], "type": { @@ -2732,7 +2947,7 @@ } }, { - "id": 68, + "id": 63, "name": "get", "kind": 1024, "kindString": "Property", @@ -2740,13 +2955,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 136, - "character": 6 + "line": 143, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L143" } ], "type": { @@ -2755,7 +2984,7 @@ } }, { - "id": 67, + "id": 62, "name": "head", "kind": 1024, "kindString": "Property", @@ -2763,13 +2992,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 135, - "character": 6 + "line": 142, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L142" } ], "type": { @@ -2781,8 +3032,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [69, 68, 67] + "children": [64, 63, 62] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 141, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L141" } ] } @@ -2792,16 +3050,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 23, + "id": 18, "name": "Schema" }, { @@ -2814,7 +3072,7 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, @@ -2857,9 +3115,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -2890,13 +3148,13 @@ }, "objectType": { "type": "reference", - "id": 62, + "id": 57, "name": "Fn" } }, { "type": "reference", - "id": 61, + "id": 56, "name": "FnName" }, { @@ -2914,7 +3172,7 @@ ] }, { - "id": 55, + "id": 50, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2922,24 +3180,29 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 89, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L96" } ], "signatures": [ { - "id": 56, + "id": 51, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 57, + "id": 52, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2952,17 +3215,22 @@ ], "parameters": [ { - "id": 58, + "id": 53, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema", "dereferenced": {} } @@ -2979,12 +3247,12 @@ }, { "type": "reference", - "id": 15, + "id": 16, "name": "ClientOptions" }, { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, { @@ -2993,7 +3261,7 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 57, + "id": 52, "name": "DynamicSchema" }, "objectType": { @@ -3032,36 +3300,39 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [10] }, { "title": "Properties", - "kind": 1024, - "children": [37, 35, 36, 34] + "children": [32, 30, 31, 29] }, { "title": "Methods", - "kind": 2048, - "children": [42, 59, 55] + "children": [37, 54, 50] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", "line": 15, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L15" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 70, + "id": 65, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + "summary": [ + { + "kind": "text", + "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" + } + ] }, "default": { "type": "intrinsic", @@ -3069,88 +3340,118 @@ } }, { - "id": 73, + "id": 69, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" }, "default": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "options" - }, - "objectType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - }, - { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 12, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 66, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 67, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 72, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "12" - } + "fileName": "src/PostgrestClient.ts", + "line": 18, + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L18" } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [72] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 19, - "character": 4 + "type": { + "type": "inferred", + "name": "I", + "constraint": { + "type": "reference", + "id": 780, + "name": "ClientServerOptions" } - ] + } } - } - ], - "name": "GetGenericDatabaseWithOptions" + ], + "groups": [ + { + "title": "Properties", + "children": [67] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 63, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L17" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "I" + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 68, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 21, + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestClient.ts#L21" + } + ] + } } } }, { - "id": 74, + "id": 70, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + "summary": [ + { + "kind": "text", + "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" + }, + { + "kind": "code", + "text": "`\"public\"`" + }, + { + "kind": "text", + "text": ", this must be supplied manually." + } + ] }, "type": { "type": "intersection", @@ -3163,23 +3464,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -3194,23 +3493,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { @@ -3228,23 +3525,21 @@ "type": "typeOperator", "operator": "keyof", "target": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -3252,7 +3547,7 @@ } }, { - "id": 75, + "id": 71, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -3267,27 +3562,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { @@ -3298,27 +3591,25 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 20, + "id": 17, "name": "SchemaName" }, "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "db" - }, - "objectType": { - "type": "reference", - "id": 787, - "typeArguments": [ - { - "type": "reference", - "id": 12, - "name": "Database" - } - ], - "name": "GetGenericDatabaseWithOptions" - } + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 12, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "falseType": { @@ -3330,18 +3621,28 @@ ] }, { - "id": 753, + "id": 749, "name": "PostgrestError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, "children": [ { - "id": 754, + "id": 750, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -3350,19 +3651,20 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "signatures": [ { - "id": 755, + "id": 751, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 756, + "id": 752, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -3370,14 +3672,14 @@ "type": { "type": "reflection", "declaration": { - "id": 757, + "id": 753, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 757, "name": "code", "kind": 1024, "kindString": "Property", @@ -3386,7 +3688,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 73 + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3395,7 +3698,7 @@ } }, { - "id": 759, + "id": 755, "name": "details", "kind": 1024, "kindString": "Property", @@ -3404,7 +3707,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3413,7 +3717,7 @@ } }, { - "id": 760, + "id": 756, "name": "hint", "kind": 1024, "kindString": "Property", @@ -3422,7 +3726,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3431,7 +3736,7 @@ } }, { - "id": 758, + "id": 754, "name": "message", "kind": 1024, "kindString": "Property", @@ -3440,7 +3745,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -3452,8 +3758,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ] } @@ -3462,7 +3775,7 @@ ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" }, "overwrites": { @@ -3477,7 +3790,7 @@ } }, { - "id": 764, + "id": 760, "name": "code", "kind": 1024, "kindString": "Property", @@ -3486,7 +3799,8 @@ { "fileName": "src/PostgrestError.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" } ], "type": { @@ -3495,7 +3809,7 @@ } }, { - "id": 762, + "id": 758, "name": "details", "kind": 1024, "kindString": "Property", @@ -3504,7 +3818,8 @@ { "fileName": "src/PostgrestError.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" } ], "type": { @@ -3513,7 +3828,7 @@ } }, { - "id": 763, + "id": 759, "name": "hint", "kind": 1024, "kindString": "Property", @@ -3522,7 +3837,8 @@ { "fileName": "src/PostgrestError.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } ], "type": { @@ -3534,66 +3850,73 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [754] + "children": [750] }, { "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "children": [760, 758, 759] } ], "sources": [ { "fileName": "src/PostgrestError.ts", "line": 6, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ] }, { - "id": 165, + "id": 161, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 166, + "id": 162, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" + } + ], "signatures": [ { - "id": 167, + "id": 163, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 168, + "id": 164, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 169, + "id": 165, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -3604,7 +3927,7 @@ } }, { - "id": 170, + "id": 166, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -3621,20 +3944,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 171, + "id": 167, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 172, + "id": 168, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -3645,7 +3968,7 @@ } }, { - "id": 173, + "id": 169, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -3656,7 +3979,7 @@ } }, { - "id": 174, + "id": 170, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -3669,7 +3992,7 @@ ], "parameters": [ { - "id": 175, + "id": 171, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -3677,14 +4000,14 @@ "type": { "type": "reflection", "declaration": { - "id": 176, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 181, + "id": 177, "name": "body", "kind": 1024, "kindString": "Property", @@ -3695,7 +4018,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -3704,7 +4028,7 @@ } }, { - "id": 184, + "id": 180, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -3715,27 +4039,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 186, + "id": 182, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 183, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3745,21 +4077,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 188, + "id": 184, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3768,9 +4100,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3779,14 +4111,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3794,7 +4126,7 @@ } }, { - "id": 179, + "id": 175, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3803,18 +4135,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 189, + "id": 185, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -3825,7 +4158,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -3834,7 +4168,7 @@ } }, { - "id": 177, + "id": 173, "name": "method", "kind": 1024, "kindString": "Property", @@ -3843,7 +4177,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -3873,7 +4208,7 @@ } }, { - "id": 180, + "id": 176, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3884,7 +4219,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -3893,7 +4229,7 @@ } }, { - "id": 182, + "id": 178, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -3904,7 +4240,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -3913,7 +4250,7 @@ } }, { - "id": 183, + "id": 179, "name": "signal", "kind": 1024, "kindString": "Property", @@ -3924,18 +4261,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 178, + "id": 174, "name": "url", "kind": 1024, "kindString": "Property", @@ -3944,22 +4282,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [181, 184, 179, 189, 177, 180, 182, 183, 178] + "children": [177, 180, 175, 185, 173, 176, 178, 179, 174] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -3968,41 +4314,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4010,19 +4356,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 536, + "id": 532, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 535, + "id": 531, "name": "default.constructor" } }, { - "id": 492, + "id": 488, "name": "body", "kind": 1024, "kindString": "Property", @@ -4034,7 +4380,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -4043,12 +4390,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 645, + "id": 641, "name": "default.body" } }, { - "id": 495, + "id": 491, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4059,27 +4406,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 496, + "id": 492, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 497, + "id": 493, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 494, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4089,21 +4444,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 499, + "id": 495, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4112,9 +4467,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4123,14 +4478,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4138,12 +4493,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 648, + "id": 644, "name": "default.fetch" } }, { - "id": 490, + "id": 486, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4154,23 +4509,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 643, + "id": 639, "name": "default.headers" } }, { - "id": 500, + "id": 496, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -4181,7 +4537,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -4190,12 +4547,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 653, + "id": 649, "name": "default.isMaybeSingle" } }, { - "id": 488, + "id": 484, "name": "method", "kind": 1024, "kindString": "Property", @@ -4206,7 +4563,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -4236,12 +4594,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 641, + "id": 637, "name": "default.method" } }, { - "id": 491, + "id": 487, "name": "schema", "kind": 1024, "kindString": "Property", @@ -4253,7 +4611,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -4262,12 +4621,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 644, + "id": 640, "name": "default.schema" } }, { - "id": 493, + "id": 489, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -4278,7 +4637,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -4288,12 +4648,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 646, + "id": 642, "name": "default.shouldThrowOnError" } }, { - "id": 494, + "id": 490, "name": "signal", "kind": 1024, "kindString": "Property", @@ -4305,23 +4665,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 647, + "id": 643, "name": "default.signal" } }, { - "id": 489, + "id": 485, "name": "url", "kind": 1024, "kindString": "Property", @@ -4332,23 +4693,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 642, + "id": 638, "name": "default.url" } }, { - "id": 457, + "id": 453, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -4357,74 +4719,85 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 195, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" } ], "signatures": [ { - "id": 458, + "id": 454, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] }, "parameters": [ { - "id": 459, + "id": 455, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] }, "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4432,19 +4805,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 607, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 606, "name": "default.abortSignal" } }, { - "id": 301, + "id": 297, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -4453,22 +4826,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 354, - "character": 2 - } - ], - "signatures": [ + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L354" + }, { - "id": 302, + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 358, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L358" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 366, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L366" + } + ], + "signatures": [ + { + "id": 298, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 303, + "id": 299, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4481,29 +4888,39 @@ ], "parameters": [ { - "id": 304, + "id": 300, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName", "dereferenced": {} } }, { - "id": 305, + "id": 301, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4524,9 +4941,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -4537,12 +4954,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 303, + "id": 299, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -4554,41 +4971,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4596,23 +5013,49 @@ } }, { - "id": 306, + "id": 302, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is contained by " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 307, + "id": 303, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -4620,13 +5063,18 @@ } }, { - "id": 308, + "id": 304, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4658,9 +5106,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -4668,41 +5116,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4712,7 +5160,7 @@ ] }, { - "id": 293, + "id": 289, "name": "contains", "kind": 2048, "kindString": "Method", @@ -4721,22 +5169,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 327, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L327" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 331, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L331" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 339, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L339" } ], "signatures": [ { - "id": 294, + "id": 290, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 295, + "id": 291, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4749,29 +5231,39 @@ ], "parameters": [ { - "id": 296, + "id": 292, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName", "dereferenced": {} } }, { - "id": 297, + "id": 293, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4792,9 +5284,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "typeOperator", @@ -4805,12 +5297,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 295, + "id": 291, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -4822,41 +5314,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4864,23 +5356,49 @@ } }, { - "id": 298, + "id": 294, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " contains every element appearing in " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 299, + "id": 295, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -4888,13 +5406,18 @@ } }, { - "id": 300, + "id": 296, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The jsonb, array, or range value to filter with" + } + ] }, "type": { "type": "union", @@ -4926,9 +5449,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } ] } @@ -4936,41 +5459,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -4980,7 +5503,7 @@ ] }, { - "id": 466, + "id": 462, "name": "csv", "kind": 2048, "kindString": "Method", @@ -4989,26 +5512,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 237, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" } ], "signatures": [ { - "id": 467, + "id": 463, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5024,19 +5561,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 616, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 619, + "id": 615, "name": "default.csv" } }, { - "id": 190, + "id": 186, "name": "eq", "kind": 2048, "kindString": "Method", @@ -5045,23 +5582,60 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 99, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L99" } ], "signatures": [ { - "id": 191, + "id": 187, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nTo check if the value of " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL, you should use " + }, + { + "kind": "code", + "text": "`.is()`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "typeParameter": [ { - "id": 192, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5074,29 +5648,39 @@ ], "parameters": [ { - "id": 193, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName", "dereferenced": {} } }, { - "id": 194, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -5105,17 +5689,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -5136,17 +5720,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 192, + "id": 188, "name": "ColumnName" } ], @@ -5164,9 +5748,9 @@ "name": "ResolvedFilterValue" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, "falseType": { "type": "intrinsic", @@ -5178,41 +5762,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5222,7 +5806,7 @@ ] }, { - "id": 470, + "id": 466, "name": "explain", "kind": 2048, "kindString": "Method", @@ -5231,42 +5815,60 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 275, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" } ], "signatures": [ { - "id": 471, + "id": 467, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." + } + ] }, "parameters": [ { - "id": 472, + "id": 468, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 473, + "id": 469, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 474, + "id": 470, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -5274,13 +5876,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 283, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { @@ -5289,7 +5905,7 @@ } }, { - "id": 477, + "id": 473, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -5297,13 +5913,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 286, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -5312,7 +5942,7 @@ } }, { - "id": 479, + "id": 475, "name": "format", "kind": 1024, "kindString": "Property", @@ -5320,13 +5950,31 @@ "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 288, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -5344,7 +5992,7 @@ } }, { - "id": 476, + "id": 472, "name": "settings", "kind": 1024, "kindString": "Property", @@ -5352,13 +6000,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 285, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" } ], "type": { @@ -5367,7 +6029,7 @@ } }, { - "id": 475, + "id": 471, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -5375,13 +6037,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 284, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { @@ -5390,7 +6074,7 @@ } }, { - "id": 478, + "id": 474, "name": "wal", "kind": 1024, "kindString": "Property", @@ -5398,13 +6082,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on WAL record generation\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { @@ -5416,8 +6114,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [474, 477, 479, 476, 475, 478] + "children": [470, 473, 475, 472, 471, 474] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" } ] } @@ -5430,11 +6135,11 @@ "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5450,11 +6155,11 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5471,9 +6176,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { @@ -5487,19 +6192,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 624, + "id": 620, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 623, + "id": 619, "name": "default.explain" } }, { - "id": 396, + "id": 392, "name": "filter", "kind": 2048, "kindString": "Method", @@ -5508,23 +6213,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 581, - "character": 2 - } - ], + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L581" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 586, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L586" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 600, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L600" + } + ], "signatures": [ { - "id": 397, + "id": 393, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 398, + "id": 394, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5537,29 +6275,39 @@ ], "parameters": [ { - "id": 399, + "id": 395, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 398, + "id": 394, "name": "ColumnName", "dereferenced": {} } }, { - "id": 400, + "id": 396, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "union", @@ -5660,13 +6408,18 @@ } }, { - "id": 401, + "id": 397, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5676,41 +6429,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5718,24 +6471,49 @@ } }, { - "id": 402, + "id": 398, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 403, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -5743,13 +6521,18 @@ } }, { - "id": 404, + "id": 400, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5757,13 +6540,18 @@ } }, { - "id": 405, + "id": 401, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -5773,41 +6561,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -5817,7 +6605,7 @@ ] }, { - "id": 468, + "id": 464, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -5826,26 +6614,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 245, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" } ], "signatures": [ { - "id": 469, + "id": 465, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -5860,9 +6662,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "literal", @@ -5873,19 +6675,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 622, + "id": 618, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 621, + "id": 617, "name": "default.geojson" } }, { - "id": 200, + "id": 196, "name": "gt", "kind": 2048, "kindString": "Method", @@ -5894,22 +6696,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 132, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L132" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 133, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L133" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 140, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L140" } ], "signatures": [ { - "id": 201, + "id": 197, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 202, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5922,40 +6758,50 @@ ], "parameters": [ { - "id": 203, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName", "dereferenced": {} } }, { - "id": 204, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 202, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -5963,41 +6809,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6005,23 +6851,49 @@ } }, { - "id": 205, + "id": 201, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 206, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6029,13 +6901,18 @@ } }, { - "id": 207, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -6045,41 +6922,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6089,7 +6966,7 @@ ] }, { - "id": 208, + "id": 204, "name": "gte", "kind": 2048, "kindString": "Method", @@ -6098,22 +6975,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 145, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L145" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 146, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L146" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 153, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L153" } ], "signatures": [ { - "id": 209, + "id": 205, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 210, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6126,40 +7037,50 @@ ], "parameters": [ { - "id": 211, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName", "dereferenced": {} } }, { - "id": 212, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 210, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -6167,41 +7088,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6209,23 +7130,49 @@ } }, { - "id": 213, + "id": 209, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 214, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6233,13 +7180,18 @@ } }, { - "id": 215, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -6249,41 +7201,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6293,7 +7245,7 @@ ] }, { - "id": 256, + "id": 252, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -6302,22 +7254,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 229, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L229" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 230, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L230" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 237, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L237" } ], "signatures": [ { - "id": 257, + "id": 253, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 258, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6330,29 +7316,39 @@ ], "parameters": [ { - "id": 259, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 258, + "id": 254, "name": "ColumnName", "dereferenced": {} } }, { - "id": 260, + "id": 256, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -6362,41 +7358,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6404,23 +7400,49 @@ } }, { - "id": 261, + "id": 257, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "parameters": [ - { - "id": 262, - "name": "column", - "kind": 32768, - "kindString": "Parameter", + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] + }, + "parameters": [ + { + "id": 258, + "name": "column", + "kind": 32768, + "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6428,13 +7450,18 @@ } }, { - "id": 263, + "id": 259, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -6444,41 +7471,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6488,7 +7515,7 @@ ] }, { - "id": 264, + "id": 260, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", @@ -6497,22 +7524,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 242, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L242" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L246" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 253, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L253" } ], "signatures": [ { - "id": 265, + "id": 261, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 266, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6525,29 +7586,39 @@ ], "parameters": [ { - "id": 267, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 266, + "id": 262, "name": "ColumnName", "dereferenced": {} } }, { - "id": 268, + "id": 264, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6564,41 +7635,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6606,23 +7677,49 @@ } }, { - "id": 269, + "id": 265, "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 270, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6630,13 +7727,18 @@ } }, { - "id": 271, + "id": 267, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6653,41 +7755,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6697,7 +7799,7 @@ ] }, { - "id": 272, + "id": 268, "name": "ilikeAnyOf", "kind": 2048, "kindString": "Method", @@ -6706,22 +7808,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 258, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L258" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 262, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L262" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 269, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L269" } ], "signatures": [ { - "id": 273, + "id": 269, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "typeParameter": [ { - "id": 274, + "id": 270, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6734,29 +7870,39 @@ ], "parameters": [ { - "id": 275, + "id": 271, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 274, + "id": 270, "name": "ColumnName", "dereferenced": {} } }, { - "id": 276, + "id": 272, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6773,41 +7919,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6815,23 +7961,49 @@ } }, { - "id": 277, + "id": 273, "name": "ilikeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-insensitively." + } + ] }, "parameters": [ { - "id": 278, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -6839,13 +8011,18 @@ } }, { - "id": 279, + "id": 275, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -6862,41 +8039,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -6906,7 +8083,7 @@ ] }, { - "id": 288, + "id": 284, "name": "in", "kind": 2048, "kindString": "Method", @@ -6915,22 +8092,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 302, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L302" } ], "signatures": [ { - "id": 289, + "id": 285, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is included in the " + }, + { + "kind": "code", + "text": "`values`" + }, + { + "kind": "text", + "text": " array." + } + ] }, "typeParameter": [ { - "id": 290, + "id": 286, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6943,29 +8142,39 @@ ], "parameters": [ { - "id": 291, + "id": 287, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName", "dereferenced": {} } }, { - "id": 292, + "id": 288, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The values array to filter with" + } + ] }, "type": { "type": "typeOperator", @@ -6979,17 +8188,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -7010,17 +8219,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 290, + "id": 286, "name": "ColumnName" } ], @@ -7046,41 +8255,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7090,7 +8299,7 @@ ] }, { - "id": 280, + "id": 276, "name": "is", "kind": 2048, "kindString": "Method", @@ -7099,23 +8308,112 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 274, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L274" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 278, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L278" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 291, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L291" } ], "signatures": [ { - "id": 281, + "id": 277, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 282, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7128,140 +8426,83 @@ ], "parameters": [ { - "id": 283, + "id": 279, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 282, + "id": 278, "name": "ColumnName", "dereferenced": {} } }, { - "id": 284, + "id": 280, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { - "type": "intersection", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": false - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 282, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 170, - "name": "Row" - } - }, - { - "type": "literal", - "value": true - } - ] - } - ] + "type": "intrinsic", + "name": "Object" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7269,24 +8510,105 @@ } }, { - "id": 285, + "id": 281, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " IS " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is NULL by setting " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\n\nFor boolean columns, you can also set " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": " and it\nwill behave the same way as " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 286, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7294,13 +8616,18 @@ } }, { - "id": 287, + "id": 283, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "union", @@ -7319,41 +8646,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7363,7 +8690,7 @@ ] }, { - "id": 232, + "id": 228, "name": "like", "kind": 2048, "kindString": "Method", @@ -7372,22 +8699,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 184, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L184" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 185, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L185" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 192, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L192" } ], "signatures": [ { - "id": 233, + "id": 229, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 234, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7400,29 +8761,39 @@ ], "parameters": [ { - "id": 235, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 234, + "id": 230, "name": "ColumnName", "dereferenced": {} } }, { - "id": 236, + "id": 232, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -7432,41 +8803,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7474,23 +8845,49 @@ } }, { - "id": 237, + "id": 233, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches " + }, + { + "kind": "code", + "text": "`pattern`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 238, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7498,13 +8895,18 @@ } }, { - "id": 239, + "id": 235, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to match with\n" + "summary": [ + { + "kind": "text", + "text": "The pattern to match with" + } + ] }, "type": { "type": "intrinsic", @@ -7514,41 +8916,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7558,7 +8960,7 @@ ] }, { - "id": 240, + "id": 236, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -7567,22 +8969,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 197, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L197" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 201, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L201" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 208, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L208" } ], "signatures": [ { - "id": 241, + "id": 237, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 242, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7595,29 +9031,39 @@ ], "parameters": [ { - "id": 243, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 242, + "id": 238, "name": "ColumnName", "dereferenced": {} } }, { - "id": 244, + "id": 240, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7634,41 +9080,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7676,23 +9122,49 @@ } }, { - "id": 245, + "id": 241, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches all of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 246, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7700,13 +9172,18 @@ } }, { - "id": 247, + "id": 243, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7723,41 +9200,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7767,7 +9244,7 @@ ] }, { - "id": 248, + "id": 244, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -7776,22 +9253,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 213, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L213" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 217, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 224, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L224" } ], "signatures": [ { - "id": 249, + "id": 245, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "typeParameter": [ { - "id": 250, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7804,29 +9315,39 @@ ], "parameters": [ { - "id": 251, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 250, + "id": 246, "name": "ColumnName", "dereferenced": {} } }, { - "id": 252, + "id": 248, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7843,41 +9364,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7885,23 +9406,49 @@ } }, { - "id": 253, + "id": 249, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-sensitively." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches any of " + }, + { + "kind": "code", + "text": "`patterns`" + }, + { + "kind": "text", + "text": " case-sensitively." + } + ] }, "parameters": [ { - "id": 254, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -7909,13 +9456,18 @@ } }, { - "id": 255, + "id": 251, "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The patterns to match with\n" + "summary": [ + { + "kind": "text", + "text": "The patterns to match with" + } + ] }, "type": { "type": "typeOperator", @@ -7932,41 +9484,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -7976,7 +9528,7 @@ ] }, { - "id": 442, + "id": 438, "name": "limit", "kind": 2048, "kindString": "Method", @@ -7985,28 +9537,47 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" } ], "signatures": [ { - "id": 443, + "id": 439, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 444, + "id": 440, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows to return" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] }, "type": { "type": "intrinsic", @@ -8014,26 +9585,31 @@ } }, { - "id": 445, + "id": 441, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 442, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 443, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8041,13 +9617,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -8056,7 +9646,7 @@ } }, { - "id": 448, + "id": 444, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8064,13 +9654,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -8082,8 +9678,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [447, 448] + "children": [443, 444] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } @@ -8093,41 +9696,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8135,19 +9738,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 596, + "id": 592, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 595, + "id": 591, "name": "default.limit" } }, { - "id": 216, + "id": 212, "name": "lt", "kind": 2048, "kindString": "Method", @@ -8156,22 +9759,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 158, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L158" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 159, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L159" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 166, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L166" } ], "signatures": [ { - "id": 217, + "id": 213, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 218, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8184,40 +9821,50 @@ ], "parameters": [ { - "id": 219, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName", "dereferenced": {} } }, { - "id": 220, + "id": 216, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 218, + "id": 214, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -8225,41 +9872,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8267,23 +9914,49 @@ } }, { - "id": 221, + "id": 217, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 222, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -8291,13 +9964,18 @@ } }, { - "id": 223, + "id": 219, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -8307,41 +9985,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8351,7 +10029,7 @@ ] }, { - "id": 224, + "id": 220, "name": "lte", "kind": 2048, "kindString": "Method", @@ -8360,22 +10038,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 171, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L171" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 172, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L172" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 179, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L179" } ], "signatures": [ { - "id": 225, + "id": 221, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 226, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8388,40 +10100,50 @@ ], "parameters": [ { - "id": 227, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName", "dereferenced": {} } }, { - "id": 228, + "id": 224, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 226, + "id": 222, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -8429,41 +10151,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8471,23 +10193,49 @@ } }, { - "id": 229, + "id": 225, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than or equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 230, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -8495,13 +10243,18 @@ } }, { - "id": 231, + "id": 227, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -8511,41 +10264,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8555,7 +10308,7 @@ ] }, { - "id": 373, + "id": 369, "name": "match", "kind": 2048, "kindString": "Method", @@ -8564,22 +10317,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 514, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L514" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 515, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L515" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 523, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L523" } ], "signatures": [ { - "id": 374, + "id": 370, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "typeParameter": [ { - "id": 375, + "id": 371, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8592,79 +10379,84 @@ ], "parameters": [ { - "id": 376, + "id": 372, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 375, + "id": 371, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8672,23 +10464,49 @@ } }, { - "id": 377, + "id": 373, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + "summary": [ + { + "kind": "text", + "text": "Match only rows where each column in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " keys is equal to its\nassociated value. Shorthand for multiple " + }, + { + "kind": "code", + "text": "`.eq()`" + }, + { + "kind": "text", + "text": "s." + } + ] }, "parameters": [ { - "id": 378, + "id": 374, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + "summary": [ + { + "kind": "text", + "text": "The object to filter with, with column names as keys mapped\nto their filter values" + } + ] }, "type": { "type": "reference", @@ -8702,49 +10520,49 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8754,7 +10572,7 @@ ] }, { - "id": 485, + "id": 481, "name": "maxAffected", "kind": 2048, "kindString": "Method", @@ -8763,28 +10581,39 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], "signatures": [ { - "id": 486, + "id": 482, "name": "maxAffected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] }, "parameters": [ { - "id": 487, + "id": 483, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" + } + ] }, "type": { "type": "intrinsic", @@ -8805,7 +10634,7 @@ }, "objectType": { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" } } @@ -8820,7 +10649,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 174, + "id": 170, "name": "Method" }, "extendsType": { @@ -8842,41 +10671,41 @@ }, "trueType": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -8906,19 +10735,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 639, + "id": 635, "name": "default.maxAffected" } } ], "inheritedFrom": { "type": "reference", - "id": 638, + "id": 634, "name": "default.maxAffected" } }, { - "id": 463, + "id": 459, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -8927,23 +10756,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 220, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], "signatures": [ { - "id": 464, + "id": 460, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, "typeParameter": [ { - "id": 465, + "id": 461, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -8952,7 +10802,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, "extendsType": { @@ -8975,11 +10825,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -8991,7 +10841,7 @@ }, { "type": "reference", - "id": 465, + "id": 461, "name": "ResultOne" } ] @@ -9005,19 +10855,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 617, + "id": 613, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 616, + "id": 612, "name": "default.maybeSingle" } }, { - "id": 195, + "id": 191, "name": "neq", "kind": 2048, "kindString": "Method", @@ -9026,22 +10876,44 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 120, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L120" } ], "signatures": [ { - "id": 196, + "id": 192, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." + "summary": [ + { + "kind": "text", + "text": "Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is not equal to " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 197, + "id": 193, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9054,29 +10926,39 @@ ], "parameters": [ { - "id": 198, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName", "dereferenced": {} } }, { - "id": 199, + "id": 195, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with" + } + ] }, "type": { "type": "conditional", @@ -9085,17 +10967,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -9116,17 +10998,17 @@ "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 197, + "id": 193, "name": "ColumnName" } ], @@ -9150,41 +11032,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9194,7 +11076,7 @@ ] }, { - "id": 379, + "id": 375, "name": "not", "kind": 2048, "kindString": "Method", @@ -9203,23 +11085,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 530, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L530" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 535, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L535" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 549, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L549" } ], "signatures": [ { - "id": 380, + "id": 376, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "typeParameter": [ { - "id": 381, + "id": 377, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9232,29 +11147,39 @@ ], "parameters": [ { - "id": 382, + "id": 378, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName", "dereferenced": {} } }, { - "id": 383, + "id": 379, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "reference", @@ -9262,24 +11187,29 @@ } }, { - "id": 384, + "id": 380, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 381, + "id": 377, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -9287,41 +11217,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9329,24 +11259,49 @@ } }, { - "id": 385, + "id": 381, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`opearator`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." + } + ] }, "parameters": [ { - "id": 386, + "id": 382, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on" + "summary": [ + { + "kind": "text", + "text": "The column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -9354,13 +11309,18 @@ } }, { - "id": 387, + "id": 383, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The operator to be negated to filter with, following\nPostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9368,13 +11328,18 @@ } }, { - "id": 388, + "id": 384, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" + "summary": [ + { + "kind": "text", + "text": "The value to filter with, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9384,41 +11349,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9428,7 +11393,7 @@ ] }, { - "id": 389, + "id": 385, "name": "or", "kind": 2048, "kindString": "Method", @@ -9437,29 +11402,55 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 569, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L569" } ], "signatures": [ { - "id": 390, + "id": 386, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" + "summary": [ + { + "kind": "text", + "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " + }, + { + "kind": "code", + "text": "`filters`" + }, + { + "kind": "text", + "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " + }, + { + "kind": "code", + "text": "`.or()`" + }, + { + "kind": "text", + "text": " filter across multiple tables." + } + ] }, "parameters": [ { - "id": 391, + "id": 387, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, following PostgREST syntax" + "summary": [ + { + "kind": "text", + "text": "The filters to use, following PostgREST syntax" + } + ] }, "type": { "type": "intrinsic", @@ -9467,26 +11458,31 @@ } }, { - "id": 392, + "id": 388, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 390, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -9494,13 +11490,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `referencedTable` instead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`referencedTable`" + }, + { + "kind": "text", + "text": " instead" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -9509,7 +11519,7 @@ } }, { - "id": 395, + "id": 391, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9517,13 +11527,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to filter on referenced tables\ninstead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to filter on referenced tables\ninstead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 574, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ], "type": { @@ -9535,8 +11551,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [394, 395] + "children": [390, 391] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 574, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L574" } ] } @@ -9546,41 +11569,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9590,7 +11613,7 @@ ] }, { - "id": 411, + "id": 407, "name": "order", "kind": 2048, "kindString": "Method", @@ -9599,23 +11622,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 412, + "id": 408, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "typeParameter": [ { - "id": 413, + "id": 409, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9628,23 +11696,28 @@ ], "parameters": [ { - "id": 414, + "id": 410, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "id": 413, + "id": 409, "name": "ColumnName", "dereferenced": {} } }, { - "id": 415, + "id": 411, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9652,19 +11725,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 416, + "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 413, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -9672,13 +11750,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9687,7 +11779,7 @@ } }, { - "id": 418, + "id": 414, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -9695,13 +11787,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9710,7 +11840,7 @@ } }, { - "id": 419, + "id": 415, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9718,13 +11848,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -9736,8 +11872,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [417, 418, 419] + "children": [413, 414, 415] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ] } @@ -9746,41 +11889,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9788,29 +11931,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 565, + "id": 561, "name": "default.order" } }, { - "id": 420, + "id": 416, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "parameters": [ { - "id": 421, + "id": 417, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "intrinsic", @@ -9818,7 +11986,7 @@ } }, { - "id": 422, + "id": 418, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9826,19 +11994,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 419, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 420, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -9846,13 +12019,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9861,7 +12048,7 @@ } }, { - "id": 425, + "id": 421, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -9869,13 +12056,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9884,7 +12109,7 @@ } }, { - "id": 426, + "id": 422, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9892,13 +12117,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -9910,8 +12141,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [424, 425, 426] + "children": [420, 421, 422] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ] } @@ -9920,41 +12158,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -9962,29 +12200,45 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 569, "name": "default.order" } }, { - "id": 427, + "id": 423, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "typeParameter": [ { - "id": 428, + "id": 424, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9997,43 +12251,37 @@ ], "parameters": [ { - "id": 429, + "id": 425, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "reference", - "id": 428, + "id": 424, "name": "ColumnName", "dereferenced": {} } }, { - "id": 430, + "id": 426, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 431, + "id": 427, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 432, + "id": 428, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -10044,7 +12292,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10053,7 +12302,7 @@ } }, { - "id": 434, + "id": 430, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10064,7 +12313,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10073,7 +12323,7 @@ } }, { - "id": 433, + "id": 429, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -10084,7 +12334,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -10096,8 +12347,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [432, 434, 433] + "children": [428, 430, 429] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ] } @@ -10106,41 +12364,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10148,63 +12406,73 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 576, "name": "default.order" } }, { - "id": 435, + "id": 431, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "parameters": [ { - "id": 436, + "id": 432, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 437, + "id": 433, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 438, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 439, + "id": 435, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -10215,7 +12483,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10224,7 +12493,7 @@ } }, { - "id": 441, + "id": 437, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10235,7 +12504,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10244,7 +12514,7 @@ } }, { - "id": 440, + "id": 436, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -10255,7 +12525,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -10267,8 +12538,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 441, 440] + "children": [435, 437, 436] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } @@ -10277,41 +12555,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10319,19 +12597,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 588, + "id": 584, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 564, + "id": 560, "name": "default.order" } }, { - "id": 349, + "id": 345, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -10340,22 +12618,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 453, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L453" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 457, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L457" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 465, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L465" } ], "signatures": [ { - "id": 350, + "id": 346, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "typeParameter": [ { - "id": 351, + "id": 347, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -10368,29 +12680,39 @@ ], "parameters": [ { - "id": 352, + "id": 348, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName", "dereferenced": {} } }, { - "id": 353, + "id": 349, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -10408,12 +12730,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 351, + "id": 347, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 170, + "id": 166, "name": "Row" } } @@ -10425,41 +12747,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10467,23 +12789,49 @@ } }, { - "id": 354, + "id": 350, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + "summary": [ + { + "kind": "text", + "text": "Only relevant for array and range columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`value`" + }, + { + "kind": "text", + "text": " have an element in common." + } + ] }, "parameters": [ { - "id": 355, + "id": 351, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The array or range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -10491,13 +12839,18 @@ } }, { - "id": 356, + "id": 352, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The array or range value to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The array or range value to filter with" + } + ] }, "type": { "type": "union", @@ -10523,41 +12876,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -10567,7 +12920,7 @@ ] }, { - "id": 519, + "id": 515, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -10576,57 +12929,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 520, + "id": 516, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 521, + "id": 517, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 526, + "id": 522, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 522, + "id": 518, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 523, + "id": 519, "name": "merge", "kind": 1024, "kindString": "Property", @@ -10637,7 +13027,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -10649,8 +13040,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [523] + "children": [519] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -10658,14 +13056,14 @@ "default": { "type": "reflection", "declaration": { - "id": 524, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 521, "name": "merge", "kind": 1024, "kindString": "Property", @@ -10674,7 +13072,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -10686,8 +13085,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [521] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -10696,11 +13102,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { @@ -10710,12 +13116,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -10740,7 +13146,7 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -10762,7 +13168,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -10770,17 +13176,17 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -10793,17 +13199,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -10815,12 +13221,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -10836,19 +13242,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 673, + "id": 669, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", - "id": 672, + "id": 668, "name": "default.overrideTypes" } }, { - "id": 449, + "id": 445, "name": "range", "kind": 2048, "kindString": "Method", @@ -10857,28 +13263,79 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 173, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" } ], "signatures": [ { - "id": 450, + "id": 446, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] }, "parameters": [ { - "id": 451, + "id": 447, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -10886,13 +13343,18 @@ } }, { - "id": 452, + "id": 448, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -10900,26 +13362,31 @@ } }, { - "id": 453, + "id": 449, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 454, + "id": 450, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 455, + "id": 451, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -10927,13 +13394,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -10942,7 +13423,7 @@ } }, { - "id": 456, + "id": 452, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -10950,13 +13431,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -10968,8 +13455,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [455, 456] + "children": [451, 452] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ] } @@ -10979,41 +13473,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11021,19 +13515,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 603, + "id": 599, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 602, + "id": 598, "name": "default.range" } }, { - "id": 341, + "id": 337, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -11042,22 +13536,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 438, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L438" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 439, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L439" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 448, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L448" } ], "signatures": [ { - "id": 342, + "id": 338, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] }, "typeParameter": [ { - "id": 343, + "id": 339, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11070,29 +13598,39 @@ ], "parameters": [ { - "id": 344, + "id": 340, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 343, + "id": 339, "name": "ColumnName", "dereferenced": {} } }, { - "id": 345, + "id": 341, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11102,41 +13640,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11144,23 +13682,49 @@ } }, { - "id": 346, + "id": 342, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is\nmutually exclusive to " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " and there can be no element between the two\nranges." + } + ] }, "parameters": [ { - "id": 347, + "id": 343, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11168,13 +13732,18 @@ } }, { - "id": 348, + "id": 344, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11184,41 +13753,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11228,7 +13797,7 @@ ] }, { - "id": 309, + "id": 305, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -11237,22 +13806,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 380, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L380" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 381, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L381" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 389, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L389" } ], "signatures": [ { - "id": 310, + "id": 306, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 311, + "id": 307, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11265,29 +13868,39 @@ ], "parameters": [ { - "id": 312, + "id": 308, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 311, + "id": 307, "name": "ColumnName", "dereferenced": {} } }, { - "id": 313, + "id": 309, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11297,41 +13910,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11339,23 +13952,49 @@ } }, { - "id": 314, + "id": 310, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is greater than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 315, + "id": 311, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11363,13 +14002,18 @@ } }, { - "id": 316, + "id": 312, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11379,41 +14023,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11423,7 +14067,7 @@ ] }, { - "id": 317, + "id": 313, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -11432,22 +14076,64 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 394, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L394" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 395, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L395" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 404, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L404" } ], "signatures": [ { - "id": 318, + "id": 314, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 319, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11460,29 +14146,39 @@ ], "parameters": [ { - "id": 320, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 319, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 321, + "id": 317, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11492,41 +14188,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11534,23 +14230,57 @@ } }, { - "id": 322, + "id": 318, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or greater than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 323, + "id": 319, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11558,13 +14288,18 @@ } }, { - "id": 324, + "id": 320, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11574,41 +14309,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11618,7 +14353,7 @@ ] }, { - "id": 325, + "id": 321, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -11627,22 +14362,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 409, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L409" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 410, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L410" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 418, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L418" } ], "signatures": [ { - "id": 326, + "id": 322, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 327, + "id": 323, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11655,29 +14424,39 @@ ], "parameters": [ { - "id": 328, + "id": 324, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 327, + "id": 323, "name": "ColumnName", "dereferenced": {} } }, { - "id": 329, + "id": 325, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11687,41 +14466,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11729,23 +14508,49 @@ } }, { - "id": 330, + "id": 326, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is less than any element in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 331, + "id": 327, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11753,13 +14558,18 @@ } }, { - "id": 332, + "id": 328, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11769,41 +14579,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11813,7 +14623,7 @@ ] }, { - "id": 333, + "id": 329, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -11822,22 +14632,64 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 423, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L423" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 424, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L424" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 433, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L433" } ], "signatures": [ { - "id": 334, + "id": 330, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 335, + "id": 331, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11850,29 +14702,39 @@ ], "parameters": [ { - "id": 336, + "id": 332, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "reference", - "id": 335, + "id": 331, "name": "ColumnName", "dereferenced": {} } }, { - "id": 337, + "id": 333, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11882,41 +14744,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -11924,23 +14786,57 @@ } }, { - "id": 338, + "id": 334, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for range columns. Match only rows where every element in\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " is either contained in " + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": " or less than any element in\n" + }, + { + "kind": "code", + "text": "`range`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 339, + "id": 335, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range column to filter on" + "summary": [ + { + "kind": "text", + "text": "The range column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -11948,13 +14844,18 @@ } }, { - "id": 340, + "id": 336, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with\n" + "summary": [ + { + "kind": "text", + "text": "The range to filter with" + } + ] }, "type": { "type": "intrinsic", @@ -11964,41 +14865,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12008,7 +14909,7 @@ ] }, { - "id": 482, + "id": 478, "name": "returns", "kind": 2048, "kindString": "Method", @@ -12017,54 +14918,78 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" } ], "signatures": [ { - "id": 483, + "id": 479, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 484, + "id": 480, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { @@ -12072,12 +14997,12 @@ "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 484, + "id": 480, "name": "NewResult" } ], @@ -12085,17 +15010,17 @@ }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12103,19 +15028,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 636, + "id": 632, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 635, + "id": 631, "name": "default.returns" } }, { - "id": 480, + "id": 476, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -12124,57 +15049,70 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" } ], "signatures": [ { - "id": 481, + "id": 477, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will still be returned, but the query is not committed." + } + ] }, "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12182,19 +15120,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 634, + "id": 630, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 633, + "id": 629, "name": "default.rollback" } }, { - "id": 406, + "id": 402, "name": "select", "kind": 2048, "kindString": "Method", @@ -12203,23 +15141,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" } ], "signatures": [ { - "id": 407, + "id": 403, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 408, + "id": 404, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -12234,43 +15217,43 @@ } }, { - "id": 409, + "id": 405, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 408, + "id": 404, "name": "Query" }, { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" } ], @@ -12280,7 +15263,7 @@ ], "parameters": [ { - "id": 410, + "id": 406, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -12288,11 +15271,16 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] }, "type": { "type": "reference", - "id": 408, + "id": 404, "name": "Query", "dereferenced": {} } @@ -12300,44 +15288,44 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 409, + "id": 405, "name": "NewResultOne" } }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12345,19 +15333,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 560, + "id": 556, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 559, + "id": 555, "name": "default.select" } }, { - "id": 503, + "id": 499, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -12366,22 +15354,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 504, + "id": 500, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 505, + "id": 501, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -12392,7 +15386,7 @@ } }, { - "id": 506, + "id": 502, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -12405,41 +15399,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12447,19 +15441,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 657, + "id": 653, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 656, + "id": 652, "name": "default.setHeader" } }, { - "id": 460, + "id": 456, "name": "single", "kind": 2048, "kindString": "Method", @@ -12468,23 +15462,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 206, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" } ], "signatures": [ { - "id": 461, + "id": 457, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise this\nreturns an error." + } + ] }, "typeParameter": [ { - "id": 462, + "id": 458, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -12493,7 +15508,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, "extendsType": { @@ -12516,16 +15531,16 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 462, + "id": 458, "name": "ResultOne" }, { @@ -12537,19 +15552,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 614, + "id": 610, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 613, + "id": 609, "name": "default.single" } }, { - "id": 357, + "id": 353, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -12558,22 +15573,56 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 476, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L476" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 481, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L481" + }, + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 496, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L496" } ], "signatures": [ { - "id": 358, + "id": 354, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 359, + "id": 355, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -12586,29 +15635,39 @@ ], "parameters": [ { - "id": 360, + "id": 356, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The text or tsvector column to filter on" + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] }, "type": { "type": "reference", - "id": 359, + "id": 355, "name": "ColumnName", "dereferenced": {} } }, { - "id": 361, + "id": 357, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The query text to match with" + "summary": [ + { + "kind": "text", + "text": "The query text to match with" + } + ] }, "type": { "type": "intrinsic", @@ -12616,7 +15675,7 @@ } }, { - "id": 362, + "id": 358, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12624,19 +15683,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 363, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 364, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -12644,13 +15708,19 @@ "isOptional": true }, "comment": { - "shortText": "The text search configuration to use" + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 479, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ], "type": { @@ -12659,7 +15729,7 @@ } }, { - "id": 365, + "id": 361, "name": "type", "kind": 1024, "kindString": "Property", @@ -12667,13 +15737,27 @@ "isOptional": true }, "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 479, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ], "type": { @@ -12698,8 +15782,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [364, 365] + "children": [360, 361] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L479" } ] } @@ -12708,41 +15799,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12750,23 +15841,49 @@ } }, { - "id": 366, + "id": 362, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + "summary": [ + { + "kind": "text", + "text": "Only relevant for text and tsvector columns. Match only rows where\n" + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": " matches the query string in " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 367, + "id": 363, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The text or tsvector column to filter on" + "summary": [ + { + "kind": "text", + "text": "The text or tsvector column to filter on" + } + ] }, "type": { "type": "intrinsic", @@ -12774,13 +15891,18 @@ } }, { - "id": 368, + "id": 364, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The query text to match with" + "summary": [ + { + "kind": "text", + "text": "The query text to match with" + } + ] }, "type": { "type": "intrinsic", @@ -12788,7 +15910,7 @@ } }, { - "id": 369, + "id": 365, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12796,19 +15918,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 370, + "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 371, + "id": 367, "name": "config", "kind": 1024, "kindString": "Property", @@ -12816,13 +15943,19 @@ "isOptional": true }, "comment": { - "shortText": "The text search configuration to use" + "summary": [ + { + "kind": "text", + "text": "The text search configuration to use" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 484, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ], "type": { @@ -12831,7 +15964,7 @@ } }, { - "id": 372, + "id": 368, "name": "type", "kind": 1024, "kindString": "Property", @@ -12839,13 +15972,27 @@ "isOptional": true }, "comment": { - "shortText": "Change how the `query` text is interpreted\n" + "summary": [ + { + "kind": "text", + "text": "Change how the " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": " text is interpreted" + } + ] }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 484, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ], "type": { @@ -12870,8 +16017,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [371, 372] + "children": [367, 368] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 484, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L484" } ] } @@ -12880,41 +16034,41 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -12924,7 +16078,7 @@ ] }, { - "id": 507, + "id": 503, "name": "then", "kind": 2048, "kindString": "Method", @@ -12933,30 +16087,31 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 508, + "id": 504, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 509, + "id": 505, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -12964,7 +16119,7 @@ } }, { - "id": 510, + "id": 506, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -12977,7 +16132,7 @@ ], "parameters": [ { - "id": 511, + "id": 507, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -12994,32 +16149,40 @@ { "type": "reflection", "declaration": { - "id": 512, + "id": 508, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 513, + "id": 509, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 514, + "id": 510, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 171, + "id": 167, "name": "Result" } ], @@ -13032,7 +16195,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -13040,13 +16203,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -13058,7 +16221,7 @@ } }, { - "id": 515, + "id": 511, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -13075,21 +16238,29 @@ { "type": "reflection", "declaration": { - "id": 516, + "id": 512, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 517, + "id": 513, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 518, + "id": 514, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -13105,7 +16276,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -13113,13 +16284,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -13139,36 +16310,36 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 661, + "id": 657, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 660, + "id": 656, "name": "default.then" } }, { - "id": 501, + "id": 497, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -13177,60 +16348,71 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 502, + "id": 498, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -13238,16 +16420,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { @@ -13261,14 +16443,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 655, + "id": 651, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 654, + "id": 650, "name": "default.throwOnError" } } @@ -13276,21 +16458,18 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [166] + "children": [162] }, { "title": "Properties", - "kind": 1024, - "children": [492, 495, 490, 500, 488, 491, 493, 494, 489] + "children": [488, 491, 486, 496, 484, 487, 489, 490, 485] }, { "title": "Methods", - "kind": 2048, "children": [ - 457, 301, 293, 466, 190, 470, 396, 468, 200, 208, 256, 264, 272, 288, 280, 232, 240, - 248, 442, 216, 224, 373, 485, 463, 195, 379, 389, 411, 349, 519, 449, 341, 309, 317, - 325, 333, 482, 480, 406, 503, 460, 357, 507, 501 + 453, 297, 289, 462, 186, 466, 392, 464, 196, 204, 252, 260, 268, 284, 276, 228, 236, + 244, 438, 212, 220, 369, 481, 459, 191, 375, 385, 407, 345, 515, 445, 337, 305, 313, + 321, 329, 478, 476, 402, 499, 456, 353, 503, 497 ] } ], @@ -13298,24 +16477,25 @@ { "fileName": "src/PostgrestFilterBuilder.ts", "line": 74, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestFilterBuilder.ts#L74" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 527, + "id": 523, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 528, + "id": 524, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13326,7 +16506,7 @@ } }, { - "id": 529, + "id": 525, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -13343,20 +16523,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 530, + "id": 526, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 531, + "id": 527, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13367,7 +16547,7 @@ } }, { - "id": 532, + "id": 528, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13378,7 +16558,7 @@ } }, { - "id": 533, + "id": 529, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -13392,41 +16572,41 @@ "extendedTypes": [ { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 168, + "id": 164, "name": "ClientOptions" }, { "type": "reference", - "id": 169, + "id": 165, "name": "Schema" }, { "type": "reference", - "id": 170, + "id": 166, "name": "Row" }, { "type": "reference", - "id": 171, + "id": 167, "name": "Result" }, { "type": "reference", - "id": 172, + "id": 168, "name": "RelationName" }, { "type": "reference", - "id": 173, + "id": 169, "name": "Relationships" }, { "type": "reference", - "id": 174, + "id": 170, "name": "Method" } ], @@ -13435,14 +16615,14 @@ ] }, { - "id": 76, + "id": 72, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 77, + "id": 73, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -13451,31 +16631,32 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L18" } ], "signatures": [ { - "id": 78, + "id": 74, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 79, + "id": 75, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 80, + "id": 76, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13486,7 +16667,7 @@ } }, { - "id": 81, + "id": 77, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -13506,7 +16687,7 @@ } }, { - "id": 82, + "id": 78, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13517,7 +16698,7 @@ } }, { - "id": 85, + "id": 81, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13526,20 +16707,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 83, + "id": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 80, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -13548,7 +16729,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -13560,8 +16742,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [84] + "children": [80] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -13579,20 +16768,20 @@ ], "parameters": [ { - "id": 86, + "id": 82, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 87, + "id": 83, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -13600,14 +16789,14 @@ "type": { "type": "reflection", "declaration": { - "id": 88, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 91, + "id": 87, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13618,27 +16807,35 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 27, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L27" } ], "type": { "type": "reflection", "declaration": { - "id": 92, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 93, + "id": 89, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 94, + "id": 90, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13648,21 +16845,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 95, + "id": 91, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13671,9 +16868,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -13682,14 +16879,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13697,7 +16894,7 @@ } }, { - "id": 89, + "id": 85, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13708,18 +16905,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 25, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L25" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 90, + "id": 86, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13730,7 +16928,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 26, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L26" } ], "type": { @@ -13742,8 +16941,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [91, 89, 90] + "children": [87, 85, 86] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 24, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L24" } ] } @@ -13752,31 +16958,31 @@ ], "type": { "type": "reference", - "id": 76, + "id": 72, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" } ], @@ -13786,7 +16992,7 @@ ] }, { - "id": 100, + "id": 96, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13797,27 +17003,35 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 102, + "id": 98, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 103, + "id": 99, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13827,21 +17041,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 104, + "id": 100, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13850,9 +17064,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -13861,14 +17075,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -13876,7 +17090,7 @@ } }, { - "id": 97, + "id": 93, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13885,18 +17099,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L13" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" } }, { - "id": 98, + "id": 94, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13907,7 +17122,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L14" } ], "type": { @@ -13916,7 +17132,7 @@ } }, { - "id": 99, + "id": 95, "name": "signal", "kind": 1024, "kindString": "Property", @@ -13927,18 +17143,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 15, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L15" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 96, + "id": 92, "name": "url", "kind": 1024, "kindString": "Property", @@ -13947,18 +17164,19 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L12" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 153, + "id": 149, "name": "delete", "kind": 2048, "kindString": "Method", @@ -13967,42 +17185,60 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 411, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L411" } ], "signatures": [ { - "id": 154, + "id": 150, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": " after filters." + } + ] }, "parameters": [ { - "id": 155, + "id": 151, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 156, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 157, + "id": 153, "name": "count", "kind": 1024, "kindString": "Property", @@ -14010,13 +17246,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count deleted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 414, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L414" } ], "type": { @@ -14041,8 +17315,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [157] + "children": [153] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 413, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L413" } ] } @@ -14052,16 +17333,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14072,7 +17353,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14082,12 +17363,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14101,7 +17382,7 @@ ] }, { - "id": 114, + "id": 110, "name": "insert", "kind": 2048, "kindString": "Method", @@ -14110,23 +17391,48 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 116, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L116" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 130, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L130" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 171, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L171" } ], "signatures": [ { - "id": 115, + "id": 111, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 116, + "id": 112, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14143,31 +17449,36 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 117, + "id": 113, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] }, "type": { "type": "reference", - "id": 116, + "id": 112, "name": "Row", "dereferenced": {} } }, { - "id": 118, + "id": 114, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14175,19 +17486,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 119, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 120, + "id": 116, "name": "count", "kind": 1024, "kindString": "Property", @@ -14195,13 +17511,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 119, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L119" } ], "type": { @@ -14226,8 +17580,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [120] + "children": [116] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 118, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L118" } ] } @@ -14236,16 +17597,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14256,7 +17617,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14266,12 +17627,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14283,18 +17644,30 @@ } }, { - "id": 121, + "id": 117, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 122, + "id": 118, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14311,33 +17684,38 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 123, + "id": 119, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", - "id": 122, + "id": 118, "name": "Row" } } }, { - "id": 124, + "id": 120, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14345,19 +17723,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 125, + "id": 121, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 126, + "id": 122, "name": "count", "kind": 1024, "kindString": "Property", @@ -14365,13 +17748,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count inserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 133, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L133" } ], "type": { @@ -14393,7 +17814,7 @@ } }, { - "id": 127, + "id": 123, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -14401,13 +17822,27 @@ "isOptional": true }, "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. Only applies for bulk\ninserts.\n" + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 134, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L134" } ], "type": { @@ -14419,8 +17854,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [126, 127] + "children": [122, 123] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 132, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L132" } ] } @@ -14429,16 +17871,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14449,7 +17891,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14459,12 +17901,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14478,7 +17920,7 @@ ] }, { - "id": 105, + "id": 101, "name": "select", "kind": 2048, "kindString": "Method", @@ -14487,22 +17929,28 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 57, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L57" } ], "signatures": [ { - "id": 106, + "id": 102, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT query on the table or view." + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT query on the table or view." + } + ] }, "typeParameter": [ { - "id": 107, + "id": 103, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -14517,18 +17965,18 @@ } }, { - "id": 108, + "id": 104, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14539,28 +17987,28 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { "type": "reference", - "id": 107, + "id": 103, "name": "Query" }, { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" } ], @@ -14570,7 +18018,7 @@ ], "parameters": [ { - "id": 109, + "id": 105, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -14578,36 +18026,50 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " + }, + { + "kind": "code", + "text": "`customName:columnName`" + } + ] }, "type": { "type": "reference", - "id": 107, + "id": 103, "name": "Query", "dereferenced": {} } }, { - "id": 110, + "id": 106, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 111, + "id": 107, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 113, + "id": 109, "name": "count", "kind": 1024, "kindString": "Property", @@ -14615,13 +18077,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows in the table or view.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 74, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L74" } ], "type": { @@ -14643,7 +18143,7 @@ } }, { - "id": 112, + "id": 108, "name": "head", "kind": 1024, "kindString": "Property", @@ -14651,13 +18151,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 73, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L73" } ], "type": { @@ -14669,8 +18191,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [113, 112] + "children": [109, 108] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 72, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L72" } ] } @@ -14680,16 +18209,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14700,7 +18229,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14708,18 +18237,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 108, + "id": 104, "name": "ResultOne" } }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14733,7 +18262,7 @@ ] }, { - "id": 146, + "id": 142, "name": "update", "kind": 2048, "kindString": "Method", @@ -14742,23 +18271,36 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 361, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L361" } ], "signatures": [ { - "id": 147, + "id": 143, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": " after filters." + } + ] }, "typeParameter": [ { - "id": 148, + "id": 144, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14775,50 +18317,60 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 149, + "id": 145, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update with\n" + "summary": [ + { + "kind": "text", + "text": "The values to update with" + } + ] }, "type": { "type": "reference", - "id": 148, + "id": 144, "name": "Row", "dereferenced": {} } }, { - "id": 150, + "id": 146, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 147, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 148, "name": "count", "kind": 1024, "kindString": "Property", @@ -14826,13 +18378,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count updated rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 366, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L366" } ], "type": { @@ -14857,8 +18447,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152] + "children": [148] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 365, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L365" } ] } @@ -14868,16 +18465,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -14888,7 +18485,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -14898,12 +18495,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -14917,7 +18514,7 @@ ] }, { - "id": 128, + "id": 124, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -14926,23 +18523,88 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 217, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L217" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 233, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L233" + }, + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 288, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L288" } ], "signatures": [ { - "id": 129, + "id": 125, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 130, + "id": 126, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -14959,31 +18621,36 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 131, + "id": 127, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { "type": "reference", - "id": 130, + "id": 126, "name": "Row", "dereferenced": {} } }, { - "id": 132, + "id": 128, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14991,19 +18658,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 133, + "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, + "id": 132, "name": "count", "kind": 1024, "kindString": "Property", @@ -15011,13 +18683,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 222, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L222" } ], "type": { @@ -15039,7 +18749,7 @@ } }, { - "id": 135, + "id": 131, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -15047,13 +18757,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 221, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L221" } ], "type": { @@ -15062,7 +18794,7 @@ } }, { - "id": 134, + "id": 130, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -15070,13 +18802,27 @@ "isOptional": true }, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + "summary": [ + { + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns are equal." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 220, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L220" } ], "type": { @@ -15088,8 +18834,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [136, 135, 134] + "children": [132, 131, 130] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 219, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L219" } ] } @@ -15098,16 +18851,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -15118,7 +18871,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -15128,12 +18881,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -15145,18 +18898,70 @@ } }, { - "id": 137, + "id": 133, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": " allows you to perform the equivalent of\n" + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": " if a row with the corresponding " + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates`" + }, + { + "kind": "text", + "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " + }, + { + "kind": "code", + "text": "`.select()`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 138, + "id": 134, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15173,33 +18978,38 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "parameters": [ { - "id": 139, + "id": 135, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + "summary": [ + { + "kind": "text", + "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", - "id": 138, + "id": 134, "name": "Row" } } }, { - "id": 140, + "id": 136, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15207,19 +19017,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 141, + "id": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 144, + "id": 140, "name": "count", "kind": 1024, "kindString": "Property", @@ -15227,13 +19042,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count upserted rows.\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 238, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L238" } ], "type": { @@ -15255,7 +19108,7 @@ } }, { - "id": 145, + "id": 141, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -15263,13 +19116,35 @@ "isOptional": true }, "comment": { - "shortText": "Make missing fields default to `null`.\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n`ignoreDuplicates: false`. This also only applies when doing bulk upserts.\n" + "summary": [ + { + "kind": "text", + "text": "Make missing fields default to " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" + }, + { + "kind": "code", + "text": "`ignoreDuplicates: false`" + }, + { + "kind": "text", + "text": ". This also only applies when doing bulk upserts." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 239, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L239" } ], "type": { @@ -15278,7 +19153,7 @@ } }, { - "id": 143, + "id": 139, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -15286,13 +19161,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", duplicate rows are ignored. If\n" + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", duplicate rows are merged with existing rows." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 237, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L237" } ], "type": { @@ -15301,7 +19198,7 @@ } }, { - "id": 142, + "id": 138, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -15309,13 +19206,27 @@ "isOptional": true }, "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + "summary": [ + { + "kind": "text", + "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" + }, + { + "kind": "code", + "text": "`onConflict`" + }, + { + "kind": "text", + "text": " columns are equal." + } + ] }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 236, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L236" } ], "type": { @@ -15327,8 +19238,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [144, 145, 143, 142] + "children": [140, 141, 139, 138] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 235, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L235" } ] } @@ -15337,16 +19255,16 @@ ], "type": { "type": "reference", - "id": 165, + "id": 161, "typeArguments": [ { "type": "reference", - "id": 79, + "id": 75, "name": "ClientOptions" }, { "type": "reference", - "id": 80, + "id": 76, "name": "Schema" }, { @@ -15357,7 +19275,7 @@ }, "objectType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" } }, @@ -15367,12 +19285,12 @@ }, { "type": "reference", - "id": 82, + "id": 78, "name": "RelationName" }, { "type": "reference", - "id": 85, + "id": 81, "name": "Relationships" }, { @@ -15389,42 +19307,40 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [77] + "children": [73] }, { "title": "Properties", - "kind": 1024, - "children": [100, 97, 98, 99, 96] + "children": [96, 93, 94, 95, 92] }, { "title": "Methods", - "kind": 2048, - "children": [153, 114, 105, 146, 128] + "children": [149, 110, 101, 142, 124] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 5, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L5" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 158, + "id": 154, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 159, + "id": 155, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15435,7 +19351,7 @@ } }, { - "id": 160, + "id": 156, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -15455,7 +19371,7 @@ } }, { - "id": 161, + "id": 157, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15466,7 +19382,7 @@ } }, { - "id": 164, + "id": 160, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15475,20 +19391,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 81, + "id": 77, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 162, + "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 163, + "id": 159, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -15497,7 +19413,8 @@ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ], "type": { @@ -15509,15 +19426,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [163] + "children": [159] } ], "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", "line": 10, - "character": 35 + "character": 35, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestQueryBuilder.ts#L10" } ] } @@ -15535,40 +19452,48 @@ ] }, { - "id": 534, + "id": 530, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 535, + "id": 531, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" + } + ], "signatures": [ { - "id": 536, + "id": 532, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 537, + "id": 533, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 538, + "id": 534, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15579,7 +19504,7 @@ } }, { - "id": 539, + "id": 535, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15596,20 +19521,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 540, + "id": 536, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 541, + "id": 537, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15620,7 +19545,7 @@ } }, { - "id": 542, + "id": 538, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15631,7 +19556,7 @@ } }, { - "id": 543, + "id": 539, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -15644,7 +19569,7 @@ ], "parameters": [ { - "id": 544, + "id": 540, "name": "builder", "kind": 32768, "kindString": "Parameter", @@ -15652,14 +19577,14 @@ "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 546, "name": "body", "kind": 1024, "kindString": "Property", @@ -15670,7 +19595,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 40, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L40" } ], "type": { @@ -15679,7 +19605,7 @@ } }, { - "id": 553, + "id": 549, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -15690,27 +19616,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 43, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L43" } ], "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 550, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 555, + "id": 551, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 552, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -15720,21 +19654,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 557, + "id": 553, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -15743,9 +19677,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -15754,14 +19688,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -15769,7 +19703,7 @@ } }, { - "id": 548, + "id": 544, "name": "headers", "kind": 1024, "kindString": "Property", @@ -15778,18 +19712,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 38, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L38" } ], "type": { "type": "reference", + "name": "HeadersInit", "qualifiedName": "HeadersInit", - "package": "typescript", - "name": "HeadersInit" + "package": "typescript" } }, { - "id": 558, + "id": 554, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -15800,7 +19735,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 44, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L44" } ], "type": { @@ -15809,7 +19745,7 @@ } }, { - "id": 546, + "id": 542, "name": "method", "kind": 1024, "kindString": "Property", @@ -15818,7 +19754,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 36, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L36" } ], "type": { @@ -15848,7 +19785,7 @@ } }, { - "id": 549, + "id": 545, "name": "schema", "kind": 1024, "kindString": "Property", @@ -15859,7 +19796,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 39, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L39" } ], "type": { @@ -15868,7 +19806,7 @@ } }, { - "id": 551, + "id": 547, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -15879,7 +19817,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 41, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L41" } ], "type": { @@ -15888,7 +19827,7 @@ } }, { - "id": 552, + "id": 548, "name": "signal", "kind": 1024, "kindString": "Property", @@ -15899,18 +19838,19 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 42, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L42" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } }, { - "id": 547, + "id": 543, "name": "url", "kind": 1024, "kindString": "Property", @@ -15919,22 +19859,30 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 37, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L37" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [550, 553, 548, 558, 546, 549, 551, 552, 547] + "children": [546, 549, 544, 554, 542, 545, 547, 548, 543] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 35, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L35" } ] } @@ -15943,41 +19891,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -15985,19 +19933,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 689, + "id": 685, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 688, + "id": 684, "name": "default.constructor" } }, { - "id": 645, + "id": 641, "name": "body", "kind": 1024, "kindString": "Property", @@ -16009,7 +19957,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 29, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L29" } ], "type": { @@ -16018,12 +19967,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 712, + "id": 708, "name": "default.body" } }, { - "id": 648, + "id": 644, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -16034,27 +19983,35 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L32" } ], "type": { "type": "reflection", "declaration": { - "id": 649, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 650, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 651, + "id": 647, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -16064,21 +20021,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 652, + "id": 648, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -16087,9 +20044,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -16098,14 +20055,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -16113,12 +20070,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 715, + "id": 711, "name": "default.fetch" } }, { - "id": 643, + "id": 639, "name": "headers", "kind": 1024, "kindString": "Property", @@ -16129,23 +20086,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 27, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", + "name": "Headers", "qualifiedName": "Headers", - "package": "typescript", - "name": "Headers" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 710, + "id": 706, "name": "default.headers" } }, { - "id": 653, + "id": 649, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -16156,7 +20114,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 33, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L33" } ], "type": { @@ -16165,12 +20124,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 720, + "id": 716, "name": "default.isMaybeSingle" } }, { - "id": 641, + "id": 637, "name": "method", "kind": 1024, "kindString": "Property", @@ -16181,7 +20140,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 25, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L25" } ], "type": { @@ -16211,12 +20171,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 708, + "id": 704, "name": "default.method" } }, { - "id": 644, + "id": 640, "name": "schema", "kind": 1024, "kindString": "Property", @@ -16228,7 +20188,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 28, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L28" } ], "type": { @@ -16237,12 +20198,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 711, + "id": 707, "name": "default.schema" } }, { - "id": 646, + "id": 642, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -16253,7 +20214,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L30" } ], "type": { @@ -16263,12 +20225,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 713, + "id": 709, "name": "default.shouldThrowOnError" } }, { - "id": 647, + "id": 643, "name": "signal", "kind": 1024, "kindString": "Property", @@ -16280,23 +20242,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L31" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 714, + "id": 710, "name": "default.signal" } }, { - "id": 642, + "id": 638, "name": "url", "kind": 1024, "kindString": "Property", @@ -16307,23 +20270,24 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 26, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 709, + "id": 705, "name": "default.url" } }, { - "id": 610, + "id": 606, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -16332,74 +20296,85 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 195, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L195" } ], "signatures": [ { - "id": 611, + "id": 607, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the AbortSignal for the fetch request." + "summary": [ + { + "kind": "text", + "text": "Set the AbortSignal for the fetch request." + } + ] }, "parameters": [ { - "id": 612, + "id": 608, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" + "summary": [ + { + "kind": "text", + "text": "The AbortSignal to use for the fetch request" + } + ] }, "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -16409,7 +20384,7 @@ ] }, { - "id": 619, + "id": 615, "name": "csv", "kind": 2048, "kindString": "Method", @@ -16418,26 +20393,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 237, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L237" } ], "signatures": [ { - "id": 620, + "id": 616, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a string in CSV format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a string in CSV format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16455,7 +20444,7 @@ ] }, { - "id": 623, + "id": 619, "name": "explain", "kind": 2048, "kindString": "Method", @@ -16464,42 +20453,60 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 275, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L275" } ], "signatures": [ { - "id": 624, + "id": 620, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query.", - "text": "You need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." + } + ] }, "parameters": [ { - "id": 625, + "id": 621, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters\n" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 626, + "id": 622, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 627, + "id": 623, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -16507,13 +20514,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query will be executed and the\nactual run time will be returned" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 283, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L283" } ], "type": { @@ -16522,7 +20543,7 @@ } }, { - "id": 630, + "id": 626, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -16530,13 +20551,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on buffer usage\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on buffer usage" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 286, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L286" } ], "type": { @@ -16545,7 +20580,7 @@ } }, { - "id": 632, + "id": 628, "name": "format", "kind": 1024, "kindString": "Property", @@ -16553,13 +20588,31 @@ "isOptional": true }, "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + "summary": [ + { + "kind": "text", + "text": "The format of the output, can be " + }, + { + "kind": "code", + "text": "`\"text\"`" + }, + { + "kind": "text", + "text": " (default)\nor " + }, + { + "kind": "code", + "text": "`\"json\"`" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 288, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L288" } ], "type": { @@ -16577,7 +20630,7 @@ } }, { - "id": 629, + "id": 625, "name": "settings", "kind": 1024, "kindString": "Property", @@ -16585,13 +20638,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on configuration\nparameters that affect query planning" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 285, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L285" } ], "type": { @@ -16600,7 +20667,7 @@ } }, { - "id": 628, + "id": 624, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -16608,13 +20675,35 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the query identifier will be returned\nand " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will include the output columns of the query" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 284, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L284" } ], "type": { @@ -16623,7 +20712,7 @@ } }, { - "id": 631, + "id": 627, "name": "wal", "kind": 1024, "kindString": "Property", @@ -16631,13 +20720,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, include information on WAL record generation\n" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", include information on WAL record generation" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 287, - "character": 4 + "character": 4, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L287" } ], "type": { @@ -16649,8 +20752,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [627, 630, 632, 629, 628, 631] + "children": [623, 626, 628, 625, 624, 627] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 282, + "character": 5, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L282" } ] } @@ -16663,11 +20773,11 @@ "types": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16683,11 +20793,11 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16704,9 +20814,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { @@ -16722,7 +20832,7 @@ ] }, { - "id": 621, + "id": 617, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -16731,26 +20841,40 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 245, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L245" } ], "signatures": [ { - "id": 622, + "id": 618, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as an object in [GeoJSON](https://geojson.org) format." + } + ] }, "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -16765,9 +20889,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, { "type": "literal", @@ -16780,7 +20904,7 @@ ] }, { - "id": 595, + "id": 591, "name": "limit", "kind": 2048, "kindString": "Method", @@ -16789,28 +20913,47 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 146, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L146" } ], "signatures": [ { - "id": 596, + "id": 592, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by `count`." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by " + }, + { + "kind": "code", + "text": "`count`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 597, + "id": 593, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows to return" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows to return" + } + ] }, "type": { "type": "intrinsic", @@ -16818,26 +20961,31 @@ } }, { - "id": 598, + "id": 594, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 599, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, + "id": 596, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -16845,13 +20993,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -16860,7 +21022,7 @@ } }, { - "id": 601, + "id": 597, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -16868,13 +21030,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 151, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ], "type": { @@ -16886,8 +21054,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [600, 601] + "children": [596, 597] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 151, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L151" } ] } @@ -16897,41 +21072,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -16941,7 +21116,7 @@ ] }, { - "id": 638, + "id": 634, "name": "maxAffected", "kind": 2048, "kindString": "Method", @@ -16950,28 +21125,39 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 354, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L354" } ], "signatures": [ { - "id": 639, + "id": 635, "name": "maxAffected", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + "summary": [ + { + "kind": "text", + "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." + } + ] }, "parameters": [ { - "id": 640, + "id": 636, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum number of rows that can be affected\n" + "summary": [ + { + "kind": "text", + "text": "The maximum number of rows that can be affected" + } + ] }, "type": { "type": "intrinsic", @@ -16992,7 +21178,7 @@ }, "objectType": { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" } } @@ -17007,7 +21193,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 543, + "id": 539, "name": "Method" }, "extendsType": { @@ -17029,41 +21215,41 @@ }, "trueType": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17095,7 +21281,7 @@ ] }, { - "id": 616, + "id": 612, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -17104,23 +21290,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 220, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L220" } ], "signatures": [ { - "id": 617, + "id": 613, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise\nthis returns an error." + } + ] }, "typeParameter": [ { - "id": 618, + "id": 614, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -17129,7 +21336,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, "extendsType": { @@ -17152,11 +21359,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -17168,7 +21375,7 @@ }, { "type": "reference", - "id": 465, + "id": 461, "name": "ResultOne" } ] @@ -17184,7 +21391,7 @@ ] }, { - "id": 564, + "id": 560, "name": "order", "kind": 2048, "kindString": "Method", @@ -17193,23 +21400,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L70" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 74, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L74" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 81, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L81" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 88, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L88" + }, + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 110, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L110" } ], "signatures": [ { - "id": 565, + "id": 561, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "typeParameter": [ { - "id": 566, + "id": 562, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -17222,23 +21474,28 @@ ], "parameters": [ { - "id": 567, + "id": 563, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "reference", - "id": 413, + "id": 409, "name": "ColumnName", "dereferenced": {} } }, { - "id": 568, + "id": 564, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -17246,19 +21503,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 565, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 570, + "id": 566, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17266,13 +21528,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17281,7 +21557,7 @@ } }, { - "id": 571, + "id": 567, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17289,13 +21565,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17304,7 +21618,7 @@ } }, { - "id": 572, + "id": 568, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -17312,13 +21626,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 72, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ], "type": { @@ -17330,8 +21650,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [570, 571, 572] + "children": [566, 567, 568] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 72, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L72" } ] } @@ -17340,41 +21667,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17382,24 +21709,49 @@ } }, { - "id": 573, + "id": 569, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" + "summary": [ + { + "kind": "text", + "text": "Order the query result by " + }, + { + "kind": "code", + "text": "`column`" + }, + { + "kind": "text", + "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " + }, + { + "kind": "code", + "text": "`!inner`" + }, + { + "kind": "text", + "text": " in the query." + } + ] }, "parameters": [ { - "id": 574, + "id": 570, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order by" + "summary": [ + { + "kind": "text", + "text": "The column to order by" + } + ] }, "type": { "type": "intrinsic", @@ -17407,7 +21759,7 @@ } }, { - "id": 575, + "id": 571, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -17415,19 +21767,24 @@ "isOptional": true }, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 576, + "id": 572, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 577, + "id": 573, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17435,13 +21792,27 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, the result will be in ascending order" + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the result will be in ascending order" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17450,7 +21821,7 @@ } }, { - "id": 578, + "id": 574, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17458,13 +21829,51 @@ "isOptional": true }, "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + "summary": [ + { + "kind": "text", + "text": "If " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear first. If " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ",\n" + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "s appear last." + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17473,7 +21882,7 @@ } }, { - "id": 579, + "id": 575, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -17481,13 +21890,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to order a referenced table by\nits columns" + "summary": [ + { + "kind": "text", + "text": "Set this to order a referenced table by\nits columns" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 76, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ], "type": { @@ -17499,8 +21914,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [577, 578, 579] + "children": [573, 574, 575] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 76, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L76" } ] } @@ -17509,41 +21931,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17551,24 +21973,40 @@ } }, { - "id": 580, + "id": 576, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "typeParameter": [ { - "id": 581, + "id": 577, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -17581,43 +22019,37 @@ ], "parameters": [ { - "id": 582, + "id": 578, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "reference", - "id": 428, + "id": 424, "name": "ColumnName", "dereferenced": {} } }, { - "id": 583, + "id": 579, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 584, + "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 585, + "id": 581, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17628,7 +22060,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17637,7 +22070,7 @@ } }, { - "id": 587, + "id": 583, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -17648,7 +22081,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17657,7 +22091,7 @@ } }, { - "id": 586, + "id": 582, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17668,7 +22102,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 83, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ], "type": { @@ -17680,8 +22115,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [585, 587, 586] + "children": [581, 583, 582] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 83, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L83" } ] } @@ -17690,41 +22132,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17732,58 +22174,68 @@ } }, { - "id": 588, + "id": 584, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n", - "tags": [ + "summary": [], + "blockTags": [ { - "tag": "deprecated", - "text": "Use `options.referencedTable` instead of `options.foreignTable`\n" + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": " instead of " + }, + { + "kind": "code", + "text": "`options.foreignTable`" + } + ] } ] }, "parameters": [ { - "id": 589, + "id": 585, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The column to order by" - }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 590, + "id": 586, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, - "comment": { - "shortText": "Named parameters" - }, "type": { "type": "reflection", "declaration": { - "id": 591, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 592, + "id": 588, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -17794,7 +22246,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17803,7 +22256,7 @@ } }, { - "id": 594, + "id": 590, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -17814,7 +22267,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17823,7 +22277,7 @@ } }, { - "id": 593, + "id": 589, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -17834,7 +22288,8 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 90, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ], "type": { @@ -17846,8 +22301,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [592, 594, 593] + "children": [588, 590, 589] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 90, + "character": 14, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L90" } ] } @@ -17856,41 +22318,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -17900,7 +22362,7 @@ ] }, { - "id": 672, + "id": 668, "name": "overrideTypes", "kind": 2048, "kindString": "Method", @@ -17909,57 +22371,94 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 276, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L276" } ], "signatures": [ { - "id": 673, + "id": 669, "name": "overrideTypes", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data` field in the response.", - "returns": "A PostgrestBuilder instance with the new type\n", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field in the response." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + } + ] + }, { - "tag": "example", - "text": "\n```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A PostgrestBuilder instance with the new type" + } + ] } ] }, "typeParameter": [ { - "id": 674, + "id": 670, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new type to cast the response data to" + "summary": [ + { + "kind": "text", + "text": "The new type to cast the response data to" + } + ] } }, { - "id": 679, + "id": 675, "name": "Options", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Optional type configuration (defaults to { merge: true })" + "summary": [ + { + "kind": "text", + "text": "Optional type configuration (defaults to { merge: true })" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 675, + "id": 671, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 676, + "id": 672, "name": "merge", "kind": 1024, "kindString": "Property", @@ -17970,7 +22469,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 22 + "character": 22, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -17982,8 +22482,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [676] + "children": [672] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 20, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -17991,14 +22498,14 @@ "default": { "type": "reflection", "declaration": { - "id": 677, + "id": 673, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 678, + "id": 674, "name": "merge", "kind": 1024, "kindString": "Property", @@ -18007,7 +22514,8 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 278, - "character": 44 + "character": 44, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ], "type": { @@ -18019,8 +22527,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [678] + "children": [674] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 278, + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L278" } ] } @@ -18029,11 +22544,11 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { @@ -18043,12 +22558,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -18073,7 +22588,7 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18095,7 +22610,7 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { @@ -18103,17 +22618,17 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], + "name": "NonNullable", "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + "package": "typescript" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -18126,17 +22641,17 @@ "typeArguments": [ { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 526, + "id": 522, "name": "Options" } ], @@ -18148,12 +22663,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 521, + "id": 517, "name": "NewResult" } ], @@ -18169,19 +22684,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 743, + "id": 739, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", - "id": 742, + "id": 738, "name": "default.overrideTypes" } }, { - "id": 602, + "id": 598, "name": "range", "kind": 2048, "kindString": "Method", @@ -18190,28 +22705,79 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 173, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L173" } ], "signatures": [ { - "id": 603, + "id": 599, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." + "summary": [ + { + "kind": "text", + "text": "Limit the query result by starting at an offset " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and ending at the offset " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " + }, + { + "kind": "code", + "text": "`from`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " values are 0-based and inclusive: " + }, + { + "kind": "code", + "text": "`range(1, 3)`" + }, + { + "kind": "text", + "text": " will include the second, third\nand fourth rows of the query." + } + ] }, "parameters": [ { - "id": 604, + "id": 600, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The starting index from which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -18219,13 +22785,18 @@ } }, { - "id": 605, + "id": 601, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result" + "summary": [ + { + "kind": "text", + "text": "The last index to which to limit the result" + } + ] }, "type": { "type": "intrinsic", @@ -18233,26 +22804,31 @@ } }, { - "id": 606, + "id": 602, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 607, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 608, + "id": 604, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -18260,13 +22836,27 @@ "isOptional": true }, "comment": { - "shortText": "Deprecated, use `options.referencedTable`\ninstead\n" + "summary": [ + { + "kind": "text", + "text": "Deprecated, use " + }, + { + "kind": "code", + "text": "`options.referencedTable`" + }, + { + "kind": "text", + "text": "\ninstead" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 9 + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -18275,7 +22865,7 @@ } }, { - "id": 609, + "id": 605, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -18283,13 +22873,19 @@ "isOptional": true }, "comment": { - "shortText": "Set this to limit rows of referenced\ntables instead of the parent table" + "summary": [ + { + "kind": "text", + "text": "Set this to limit rows of referenced\ntables instead of the parent table" + } + ] }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 179, - "character": 32 + "character": 32, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ], "type": { @@ -18301,8 +22897,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [608, 609] + "children": [604, 605] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 179, + "character": 7, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L179" } ] } @@ -18312,41 +22915,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18356,7 +22959,7 @@ ] }, { - "id": 635, + "id": 631, "name": "returns", "kind": 2048, "kindString": "Method", @@ -18365,54 +22968,78 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 328, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L328" } ], "signatures": [ { - "id": 636, + "id": 632, "name": "returns", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Override the type of the returned `data`.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "Override the type of the returned " + }, + { + "kind": "code", + "text": "`data`" + }, { - "tag": "deprecated", - "text": "Use overrideTypes() method at the end of your call chain instead\n" + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use overrideTypes() method at the end of your call chain instead" + } + ] } ] }, "typeParameter": [ { - "id": 637, + "id": 633, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The new result type to override with" + "summary": [ + { + "kind": "text", + "text": "The new result type to override with" + } + ] } } ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { @@ -18420,12 +23047,12 @@ "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 484, + "id": 480, "name": "NewResult" } ], @@ -18433,17 +23060,17 @@ }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18451,19 +23078,19 @@ }, "overwrites": { "type": "reference", - "id": 740, + "id": 736, "name": "default.returns" } } ], "overwrites": { "type": "reference", - "id": 739, + "id": 735, "name": "default.returns" } }, { - "id": 633, + "id": 629, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -18472,57 +23099,70 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 317, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L317" } ], "signatures": [ { - "id": 634, + "id": 630, "name": "rollback", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" + "summary": [ + { + "kind": "text", + "text": "Rollback the query.\n\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will still be returned, but the query is not committed." + } + ] }, "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18532,7 +23172,7 @@ ] }, { - "id": 559, + "id": 555, "name": "select", "kind": 2048, "kindString": "Method", @@ -18541,23 +23181,68 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L29" } ], "signatures": [ { - "id": 560, + "id": 556, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + "summary": [ + { + "kind": "text", + "text": "Perform a SELECT on the query result.\n\nBy default, " + }, + { + "kind": "code", + "text": "`.insert()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.update()`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`.upsert()`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`.delete()`" + }, + { + "kind": "text", + "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": "." + } + ] }, "typeParameter": [ { - "id": 561, + "id": 557, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -18572,43 +23257,43 @@ } }, { - "id": 562, + "id": 558, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 792, + "id": 783, "typeArguments": [ { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 408, + "id": 404, "name": "Query" }, { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" } ], @@ -18618,7 +23303,7 @@ ], "parameters": [ { - "id": 563, + "id": 559, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -18626,11 +23311,16 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas\n" + "summary": [ + { + "kind": "text", + "text": "The columns to retrieve, separated by commas" + } + ] }, "type": { "type": "reference", - "id": 408, + "id": 404, "name": "Query", "dereferenced": {} } @@ -18638,44 +23328,44 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 409, + "id": 405, "name": "NewResultOne" } }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18685,7 +23375,7 @@ ] }, { - "id": 656, + "id": 652, "name": "setHeader", "kind": 2048, "kindString": "Method", @@ -18694,22 +23384,28 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L78" } ], "signatures": [ { - "id": 657, + "id": 653, "name": "setHeader", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set an HTTP header for the request." + "summary": [ + { + "kind": "text", + "text": "Set an HTTP header for the request." + } + ] }, "parameters": [ { - "id": 658, + "id": 654, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -18720,7 +23416,7 @@ } }, { - "id": 659, + "id": 655, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -18733,41 +23429,41 @@ ], "type": { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -18775,19 +23471,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 724, + "id": 720, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", - "id": 723, + "id": 719, "name": "default.setHeader" } }, { - "id": 613, + "id": 609, "name": "single", "kind": 2048, "kindString": "Method", @@ -18796,23 +23492,44 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 206, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L206" } ], "signatures": [ { - "id": 614, + "id": 610, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + "summary": [ + { + "kind": "text", + "text": "Return " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " + }, + { + "kind": "code", + "text": "`.limit(1)`" + }, + { + "kind": "text", + "text": "), otherwise this\nreturns an error." + } + ] }, "typeParameter": [ { - "id": 615, + "id": 611, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -18821,7 +23538,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, "extendsType": { @@ -18844,16 +23561,16 @@ ], "type": { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 462, + "id": 458, "name": "ResultOne" }, { @@ -18867,7 +23584,7 @@ ] }, { - "id": 660, + "id": 656, "name": "then", "kind": 2048, "kindString": "Method", @@ -18876,30 +23593,31 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 84, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L84" } ], "signatures": [ { - "id": 661, + "id": 657, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 662, + "id": 658, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18907,7 +23625,7 @@ } }, { - "id": 663, + "id": 659, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -18920,7 +23638,7 @@ ], "parameters": [ { - "id": 664, + "id": 660, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -18937,32 +23655,40 @@ { "type": "reflection", "declaration": { - "id": 665, + "id": 661, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 91, + "character": 9, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L91" + } + ], "signatures": [ { - "id": 666, + "id": 662, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 667, + "id": 663, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -18975,7 +23701,7 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { @@ -18983,13 +23709,13 @@ "typeArguments": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -19001,7 +23727,7 @@ } }, { - "id": 668, + "id": 664, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -19018,21 +23744,29 @@ { "type": "reflection", "declaration": { - "id": 669, + "id": 665, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 98, + "character": 18, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L98" + } + ], "signatures": [ { - "id": 670, + "id": 666, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 671, + "id": 667, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -19048,7 +23782,7 @@ "types": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" }, { @@ -19056,13 +23790,13 @@ "typeArguments": [ { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" } ] } @@ -19082,36 +23816,36 @@ "types": [ { "type": "reference", - "id": 509, + "id": 505, "name": "TResult1" }, { "type": "reference", - "id": 510, + "id": 506, "name": "TResult2" } ] } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 728, + "id": 724, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 727, + "id": 723, "name": "default.then" } }, { - "id": 654, + "id": 650, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -19120,60 +23854,71 @@ { "fileName": "src/PostgrestBuilder.ts", "line": 70, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestBuilder.ts#L70" } ], "signatures": [ { - "id": 655, + "id": 651, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + "summary": [ + { + "kind": "text", + "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://github.com/supabase/supabase-js/issues/92", + "target": "https://github.com/supabase/supabase-js/issues/92" + } + ] }, "type": { "type": "intersection", "types": [ { "type": "reference", - "id": 534, + "id": 530, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 538, + "id": 534, "name": "Schema" }, { "type": "reference", - "id": 539, + "id": 535, "name": "Row" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { "type": "reference", - "id": 541, + "id": 537, "name": "RelationName" }, { "type": "reference", - "id": 542, + "id": 538, "name": "Relationships" }, { "type": "reference", - "id": 543, + "id": 539, "name": "Method" } ], @@ -19181,16 +23926,16 @@ }, { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" }, { @@ -19204,14 +23949,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 722, + "id": 718, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 721, + "id": 717, "name": "default.throwOnError" } } @@ -19219,19 +23964,16 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [535] + "children": [531] }, { "title": "Properties", - "kind": 1024, - "children": [645, 648, 643, 653, 641, 644, 646, 647, 642] + "children": [641, 644, 639, 649, 637, 640, 642, 643, 638] }, { "title": "Methods", - "kind": 2048, "children": [ - 610, 619, 623, 621, 595, 638, 616, 564, 672, 602, 635, 633, 559, 656, 613, 660, 654 + 606, 615, 619, 617, 591, 634, 612, 560, 668, 598, 631, 629, 555, 652, 609, 656, 650 ] } ], @@ -19239,24 +23981,25 @@ { "fileName": "src/PostgrestTransformBuilder.ts", "line": 11, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestTransformBuilder.ts#L11" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 680, + "id": 676, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } }, { - "id": 681, + "id": 677, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -19267,7 +24010,7 @@ } }, { - "id": 682, + "id": 678, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -19284,20 +24027,20 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 683, + "id": 679, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 684, + "id": 680, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -19308,7 +24051,7 @@ } }, { - "id": 685, + "id": 681, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -19319,7 +24062,7 @@ } }, { - "id": 686, + "id": 682, "name": "Method", "kind": 131072, "kindString": "Type parameter", @@ -19333,16 +24076,16 @@ "extendedTypes": [ { "type": "reference", - "id": 687, + "id": 683, "typeArguments": [ { "type": "reference", - "id": 537, + "id": 533, "name": "ClientOptions" }, { "type": "reference", - "id": 540, + "id": 536, "name": "Result" } ], @@ -19352,20 +24095,20 @@ "extendedBy": [ { "type": "reference", - "id": 165, + "id": 161, "name": "PostgrestFilterBuilder" } ] }, { - "id": 767, + "id": 763, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 770, + "id": 766, "name": "count", "kind": 1024, "kindString": "Property", @@ -19374,7 +24117,8 @@ { "fileName": "src/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L24" } ], "type": { @@ -19383,7 +24127,7 @@ } }, { - "id": 769, + "id": 765, "name": "data", "kind": 1024, "kindString": "Property", @@ -19392,7 +24136,8 @@ { "fileName": "src/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L23" } ], "type": { @@ -19401,7 +24146,7 @@ } }, { - "id": 768, + "id": 764, "name": "error", "kind": 1024, "kindString": "Property", @@ -19410,26 +24155,37 @@ { "fileName": "src/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L22" } ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default", "dereferenced": { - "id": 753, + "id": 749, "name": "PostgrestError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, "children": [ { - "id": 754, + "id": 750, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -19438,19 +24194,20 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "signatures": [ { - "id": 755, + "id": 751, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 756, + "id": 752, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -19458,14 +24215,14 @@ "type": { "type": "reflection", "declaration": { - "id": 757, + "id": 753, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 757, "name": "code", "kind": 1024, "kindString": "Property", @@ -19474,7 +24231,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 73 + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -19483,7 +24241,7 @@ } }, { - "id": 759, + "id": 755, "name": "details", "kind": 1024, "kindString": "Property", @@ -19492,7 +24250,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -19501,7 +24260,7 @@ } }, { - "id": 760, + "id": 756, "name": "hint", "kind": 1024, "kindString": "Property", @@ -19510,7 +24269,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -19519,7 +24279,7 @@ } }, { - "id": 758, + "id": 754, "name": "message", "kind": 1024, "kindString": "Property", @@ -19528,7 +24288,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -19540,8 +24301,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ] } @@ -19550,7 +24318,7 @@ ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" }, "overwrites": { @@ -19565,7 +24333,7 @@ } }, { - "id": 764, + "id": 760, "name": "code", "kind": 1024, "kindString": "Property", @@ -19574,7 +24342,8 @@ { "fileName": "src/PostgrestError.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" } ], "type": { @@ -19583,7 +24352,7 @@ } }, { - "id": 762, + "id": 758, "name": "details", "kind": 1024, "kindString": "Property", @@ -19592,7 +24361,8 @@ { "fileName": "src/PostgrestError.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" } ], "type": { @@ -19601,7 +24371,7 @@ } }, { - "id": 763, + "id": 759, "name": "hint", "kind": 1024, "kindString": "Property", @@ -19610,7 +24380,8 @@ { "fileName": "src/PostgrestError.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } ], "type": { @@ -19622,35 +24393,34 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [754] + "children": [750] }, { "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "children": [760, 758, 759] } ], "sources": [ { "fileName": "src/PostgrestError.ts", "line": 6, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ] } } }, { - "id": 771, + "id": 767, "name": "status", "kind": 1024, "kindString": "Property", @@ -19659,7 +24429,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -19672,7 +24443,7 @@ } }, { - "id": 772, + "id": 768, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -19681,7 +24452,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -19697,15 +24469,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [770, 769, 768, 771, 772] + "children": [766, 765, 764, 767, 768] } ], "sources": [ { "fileName": "src/types.ts", "line": 21, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L21" } ], "extendedTypes": [ @@ -19716,14 +24488,14 @@ ] }, { - "id": 773, + "id": 769, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 776, + "id": 772, "name": "count", "kind": 1024, "kindString": "Property", @@ -19732,7 +24504,8 @@ { "fileName": "src/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L19" } ], "type": { @@ -19750,7 +24523,7 @@ } }, { - "id": 775, + "id": 771, "name": "data", "kind": 1024, "kindString": "Property", @@ -19759,18 +24532,19 @@ { "fileName": "src/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L18" } ], "type": { "type": "reference", - "id": 779, + "id": 775, "name": "T", "dereferenced": {} } }, { - "id": 774, + "id": 770, "name": "error", "kind": 1024, "kindString": "Property", @@ -19779,7 +24553,8 @@ { "fileName": "src/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L17" } ], "type": { @@ -19788,7 +24563,7 @@ } }, { - "id": 777, + "id": 773, "name": "status", "kind": 1024, "kindString": "Property", @@ -19797,7 +24572,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -19810,7 +24586,7 @@ } }, { - "id": 778, + "id": 774, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -19819,7 +24595,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -19835,20 +24612,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [776, 775, 774, 777, 778] + "children": [772, 771, 770, 773, 774] } ], "sources": [ { "fileName": "src/types.ts", "line": 16, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 779, + "id": 775, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -19860,313 +24637,72 @@ "type": "reference", "name": "PostgrestResponseBase" } - ] - }, - { - "id": 784, - "name": "ClientServerOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 74, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 785, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 786, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 75, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 74, - "character": 34 - } - ] - } - } - }, - { - "id": 787, - "name": "GetGenericDatabaseWithOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 85, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 788, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - }, - { - "id": 791, - "name": "Opts", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "default": { - "type": "reflection", - "declaration": { - "id": 789, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 790, - "name": "PostgrestVersion", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 39 - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [790] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 87, - "character": 37 - } - ] - } - } - } + ] + }, + { + "id": 780, + "name": "PostgrestClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 74, + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" + } ], "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "typeArguments": [ + "type": "reflection", + "declaration": { + "id": 781, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "type": "reference", - "id": 788, - "name": "Database" + "id": 782, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 75, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L75" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "name": "IsAny" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, + "groups": [ { - "type": "reference", - "id": 791, - "name": "Opts" + "title": "Properties", + "children": [782] } ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 784, - "name": "ClientServerOptions" - }, - "trueType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - }, - "objectType": { - "type": "reference", - "id": 788, - "name": "Database" - } - } - ], - "name": "DatabaseWithOptions" - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "query", - "queryType": { - "type": "reference", - "name": "INTERNAL_SUPABASE_OPTIONS" - } - } - ], - "qualifiedName": "Omit", - "package": "typescript", - "name": "Omit" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" + "sources": [ + { + "fileName": "src/types.ts", + "line": 74, + "character": 34, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L74" } - }, - "falseType": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 788, - "name": "Database" - }, - { - "type": "reference", - "id": 791, - "name": "Opts" - } - ], - "name": "DatabaseWithOptions" - } + ] } } }, { - "id": 782, + "id": 778, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -20175,12 +24711,13 @@ { "fileName": "src/types.ts", "line": 31, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L31" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 783, + "id": 779, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20189,14 +24726,14 @@ ], "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 783, + "id": 779, "name": "T" }, { @@ -20210,7 +24747,7 @@ } }, { - "id": 765, + "id": 761, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -20219,12 +24756,13 @@ { "fileName": "src/types.ts", "line": 32, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L32" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 766, + "id": 762, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20233,13 +24771,13 @@ ], "type": { "type": "reference", - "id": 780, + "id": 776, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 766, + "id": 762, "name": "T" } } @@ -20248,7 +24786,7 @@ } }, { - "id": 780, + "id": 776, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -20257,12 +24795,13 @@ { "fileName": "src/types.ts", "line": 30, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L30" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 781, + "id": 777, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20273,14 +24812,14 @@ "type": "union", "types": [ { - "id": 773, + "id": 769, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 776, + "id": 772, "name": "count", "kind": 1024, "kindString": "Property", @@ -20289,7 +24828,8 @@ { "fileName": "src/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L19" } ], "type": { @@ -20307,7 +24847,7 @@ } }, { - "id": 775, + "id": 771, "name": "data", "kind": 1024, "kindString": "Property", @@ -20316,18 +24856,19 @@ { "fileName": "src/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L18" } ], "type": { "type": "reference", - "id": 779, + "id": 775, "name": "T", "dereferenced": {} } }, { - "id": 774, + "id": 770, "name": "error", "kind": 1024, "kindString": "Property", @@ -20336,7 +24877,8 @@ { "fileName": "src/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L17" } ], "type": { @@ -20345,7 +24887,7 @@ } }, { - "id": 777, + "id": 773, "name": "status", "kind": 1024, "kindString": "Property", @@ -20354,7 +24896,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -20367,7 +24910,7 @@ } }, { - "id": 778, + "id": 774, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -20376,7 +24919,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -20392,20 +24936,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [776, 775, 774, 777, 778] + "children": [772, 771, 770, 773, 774] } ], "sources": [ { "fileName": "src/types.ts", "line": 16, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L16" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 779, + "id": 775, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20420,14 +24964,14 @@ ] }, { - "id": 767, + "id": 763, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 770, + "id": 766, "name": "count", "kind": 1024, "kindString": "Property", @@ -20436,7 +24980,8 @@ { "fileName": "src/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L24" } ], "type": { @@ -20445,7 +24990,7 @@ } }, { - "id": 769, + "id": 765, "name": "data", "kind": 1024, "kindString": "Property", @@ -20454,7 +24999,8 @@ { "fileName": "src/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L23" } ], "type": { @@ -20463,7 +25009,7 @@ } }, { - "id": 768, + "id": 764, "name": "error", "kind": 1024, "kindString": "Property", @@ -20472,26 +25018,37 @@ { "fileName": "src/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L22" } ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default", "dereferenced": { - "id": 753, + "id": 749, "name": "PostgrestError", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + "summary": [ + { + "kind": "text", + "text": "Error format\n\n" + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", + "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" + } + ] }, "children": [ { - "id": 754, + "id": 750, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -20500,19 +25057,20 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "signatures": [ { - "id": 755, + "id": 751, "name": "new PostgrestError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 756, + "id": 752, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -20520,14 +25078,14 @@ "type": { "type": "reflection", "declaration": { - "id": 757, + "id": 753, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 761, + "id": 757, "name": "code", "kind": 1024, "kindString": "Property", @@ -20536,7 +25094,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 73 + "character": 73, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -20545,7 +25104,7 @@ } }, { - "id": 759, + "id": 755, "name": "details", "kind": 1024, "kindString": "Property", @@ -20554,7 +25113,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 42 + "character": 42, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -20563,7 +25123,7 @@ } }, { - "id": 760, + "id": 756, "name": "hint", "kind": 1024, "kindString": "Property", @@ -20572,7 +25132,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 59 + "character": 59, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -20581,7 +25142,7 @@ } }, { - "id": 758, + "id": 754, "name": "message", "kind": 1024, "kindString": "Property", @@ -20590,7 +25151,8 @@ { "fileName": "src/PostgrestError.ts", "line": 11, - "character": 25 + "character": 25, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ], "type": { @@ -20602,8 +25164,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [761, 759, 760, 758] + "children": [757, 755, 756, 754] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 23, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L11" } ] } @@ -20612,7 +25181,7 @@ ], "type": { "type": "reference", - "id": 753, + "id": 749, "name": "default" }, "overwrites": { @@ -20627,7 +25196,7 @@ } }, { - "id": 764, + "id": 760, "name": "code", "kind": 1024, "kindString": "Property", @@ -20636,7 +25205,8 @@ { "fileName": "src/PostgrestError.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L9" } ], "type": { @@ -20645,7 +25215,7 @@ } }, { - "id": 762, + "id": 758, "name": "details", "kind": 1024, "kindString": "Property", @@ -20654,7 +25224,8 @@ { "fileName": "src/PostgrestError.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L7" } ], "type": { @@ -20663,7 +25234,7 @@ } }, { - "id": 763, + "id": 759, "name": "hint", "kind": 1024, "kindString": "Property", @@ -20672,7 +25243,8 @@ { "fileName": "src/PostgrestError.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L8" } ], "type": { @@ -20684,35 +25256,34 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [754] + "children": [750] }, { "title": "Properties", - "kind": 1024, - "children": [764, 762, 763] + "children": [760, 758, 759] } ], "sources": [ { "fileName": "src/PostgrestError.ts", "line": 6, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ] } } }, { - "id": 771, + "id": 767, "name": "status", "kind": 1024, "kindString": "Property", @@ -20721,7 +25292,8 @@ { "fileName": "src/types.ts", "line": 13, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L13" } ], "type": { @@ -20734,7 +25306,7 @@ } }, { - "id": 772, + "id": 768, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -20743,7 +25315,8 @@ { "fileName": "src/types.ts", "line": 14, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L14" } ], "type": { @@ -20759,15 +25332,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [770, 769, 768, 771, 772] + "children": [766, 765, 764, 767, 768] } ], "sources": [ { "fileName": "src/types.ts", "line": 21, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/types.ts#L21" } ], "extendedTypes": [ @@ -20781,30 +25354,41 @@ } }, { - "id": 792, + "id": 783, "name": "UnstableGetResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "Main entry point for constructing the result type of a PostgREST query." + "summary": [ + { + "kind": "text", + "text": "Main entry point for constructing the result type of a PostgREST query." + } + ] }, "sources": [ { "fileName": "src/select-query-parser/result.ts", "line": 37, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/select-query-parser/result.ts#L37" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 793, + "id": 784, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Database schema." + "summary": [ + { + "kind": "text", + "text": "Database schema." + } + ] }, "type": { "type": "reference", @@ -20812,13 +25396,18 @@ } }, { - "id": 794, + "id": 785, "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The type of a row in the current table." + "summary": [ + { + "kind": "text", + "text": "The type of a row in the current table." + } + ] }, "type": { "type": "reference", @@ -20832,39 +25421,54 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 795, + "id": 786, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The name of the current table or view." + "summary": [ + { + "kind": "text", + "text": "The name of the current table or view." + } + ] } }, { - "id": 796, + "id": 787, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "Relationships of the current table." + "summary": [ + { + "kind": "text", + "text": "Relationships of the current table." + } + ] } }, { - "id": 797, + "id": 788, "name": "Query", "kind": 131072, "kindString": "Type parameter", "flags": {}, "comment": { - "shortText": "The select query string literal to parse.\n" + "summary": [ + { + "kind": "text", + "text": "The select query string literal to parse." + } + ] }, "type": { "type": "intrinsic", @@ -20872,14 +25476,14 @@ } }, { - "id": 798, + "id": 789, "name": "ClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 784, + "id": 780, "name": "ClientServerOptions" } } @@ -20891,7 +25495,7 @@ "typeArguments": [ { "type": "reference", - "id": 793, + "id": 784, "name": "Schema" } ], @@ -20908,7 +25512,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -20935,7 +25539,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -20971,7 +25575,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, "extendsType": { @@ -20985,7 +25589,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -21019,7 +25623,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -21028,7 +25632,7 @@ }, "trueType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "falseType": { @@ -21038,7 +25642,7 @@ }, { "type": "reference", - "id": 794, + "id": 785, "name": "Row" } ], @@ -21051,7 +25655,7 @@ }, "falseType": { "type": "reference", - "id": 794, + "id": 785, "name": "Row" } }, @@ -21062,7 +25666,7 @@ "typeArguments": [ { "type": "reference", - "id": 797, + "id": 788, "name": "Query" } ], @@ -21089,7 +25693,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, "extendsType": { @@ -21100,7 +25704,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, "extendsType": { @@ -21115,27 +25719,27 @@ "typeArguments": [ { "type": "reference", - "id": 798, + "id": 789, "name": "ClientOptions" }, { "type": "reference", - "id": 793, + "id": 784, "name": "Schema" }, { "type": "reference", - "id": 794, + "id": 785, "name": "Row" }, { "type": "reference", - "id": 795, + "id": 786, "name": "RelationName" }, { "type": "reference", - "id": 796, + "id": 787, "name": "Relationships" }, { @@ -21190,7 +25794,8 @@ { "fileName": "src/index.ts", "line": 17, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" } ], "type": { @@ -21208,11 +25813,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L22" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 687, + "id": 683, "name": "default" } } @@ -21223,6 +25836,14 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L18" + } + ], "type": { "type": "query", "queryType": { @@ -21238,11 +25859,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L23" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 753, + "id": 749, "name": "default" } } @@ -21253,11 +25882,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 20, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L20" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 165, + "id": 161, "name": "default" } } @@ -21268,11 +25905,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L19" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 76, + "id": 72, "name": "default" } } @@ -21283,11 +25928,19 @@ "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L21" + } + ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 534, + "id": 530, "name": "default" } } @@ -21296,9 +25949,16 @@ "groups": [ { "title": "Properties", - "kind": 1024, "children": [7, 3, 8, 5, 4, 6] } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 15, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L17" + } ] } } @@ -21307,22 +25967,18 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [687, 9, 753, 165, 76, 534] + "children": [683, 9, 749, 161, 72, 530] }, { "title": "Interfaces", - "kind": 256, - "children": [767, 773] + "children": [763, 769] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [784, 787, 782, 765, 780, 792] + "children": [780, 778, 761, 776, 783] }, { "title": "Variables", - "kind": 32, "children": [1] } ], @@ -21330,7 +25986,8 @@ { "fileName": "src/index.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/postgrest-js/blob/ede89d0/src/index.ts#L2" } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json index e0b0f9f3436ea..c91c689d36a3a 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json @@ -6,14 +6,14 @@ "flags": {}, "children": [ { - "id": 629, + "id": 671, "name": "REALTIME_LISTEN_TYPES", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 630, + "id": 672, "name": "BROADCAST", "variant": "declaration", "kind": 16, @@ -21,9 +21,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 98, + "line": 102, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L102" } ], "type": { @@ -32,7 +32,7 @@ } }, { - "id": 632, + "id": 674, "name": "POSTGRES_CHANGES", "variant": "declaration", "kind": 16, @@ -40,9 +40,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 100, + "line": 104, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L100" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L104" } ], "type": { @@ -51,7 +51,7 @@ } }, { - "id": 631, + "id": 673, "name": "PRESENCE", "variant": "declaration", "kind": 16, @@ -59,9 +59,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 99, + "line": 103, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L99" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L103" } ], "type": { @@ -70,7 +70,7 @@ } }, { - "id": 633, + "id": 675, "name": "SYSTEM", "variant": "declaration", "kind": 16, @@ -78,9 +78,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 101, + "line": 105, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L101" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L105" } ], "type": { @@ -92,27 +92,27 @@ "groups": [ { "title": "Enumeration Members", - "children": [630, 632, 631, 633] + "children": [672, 674, 673, 675] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 97, + "line": 101, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L101" } ] }, { - "id": 634, + "id": 676, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 635, + "id": 677, "name": "ALL", "variant": "declaration", "kind": 16, @@ -120,9 +120,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 91, + "line": 95, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L91" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L95" } ], "type": { @@ -131,7 +131,7 @@ } }, { - "id": 638, + "id": 680, "name": "DELETE", "variant": "declaration", "kind": 16, @@ -139,9 +139,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 94, + "line": 98, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L94" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L98" } ], "type": { @@ -150,7 +150,7 @@ } }, { - "id": 636, + "id": 678, "name": "INSERT", "variant": "declaration", "kind": 16, @@ -158,9 +158,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 92, + "line": 96, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L92" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L96" } ], "type": { @@ -169,7 +169,7 @@ } }, { - "id": 637, + "id": 679, "name": "UPDATE", "variant": "declaration", "kind": 16, @@ -177,9 +177,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 93, + "line": 97, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L93" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L97" } ], "type": { @@ -191,27 +191,27 @@ "groups": [ { "title": "Enumeration Members", - "children": [635, 638, 636, 637] + "children": [677, 680, 678, 679] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 90, + "line": 94, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L90" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L94" } ] }, { - "id": 639, + "id": 681, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 641, + "id": 683, "name": "JOIN", "variant": "declaration", "kind": 16, @@ -221,7 +221,7 @@ "fileName": "src/RealtimePresence.ts", "line": 37, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L37" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L37" } ], "type": { @@ -230,7 +230,7 @@ } }, { - "id": 642, + "id": 684, "name": "LEAVE", "variant": "declaration", "kind": 16, @@ -240,7 +240,7 @@ "fileName": "src/RealtimePresence.ts", "line": 38, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L38" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L38" } ], "type": { @@ -249,7 +249,7 @@ } }, { - "id": 640, + "id": 682, "name": "SYNC", "variant": "declaration", "kind": 16, @@ -259,7 +259,7 @@ "fileName": "src/RealtimePresence.ts", "line": 36, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L36" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L36" } ], "type": { @@ -271,7 +271,7 @@ "groups": [ { "title": "Enumeration Members", - "children": [641, 642, 640] + "children": [683, 684, 682] } ], "sources": [ @@ -279,19 +279,19 @@ "fileName": "src/RealtimePresence.ts", "line": 35, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L35" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L35" } ] }, { - "id": 643, + "id": 685, "name": "REALTIME_SUBSCRIBE_STATES", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 647, + "id": 689, "name": "CHANNEL_ERROR", "variant": "declaration", "kind": 16, @@ -299,9 +299,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 108, + "line": 112, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L108" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L112" } ], "type": { @@ -310,7 +310,7 @@ } }, { - "id": 646, + "id": 688, "name": "CLOSED", "variant": "declaration", "kind": 16, @@ -318,9 +318,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 107, + "line": 111, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L107" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L111" } ], "type": { @@ -329,7 +329,7 @@ } }, { - "id": 644, + "id": 686, "name": "SUBSCRIBED", "variant": "declaration", "kind": 16, @@ -337,9 +337,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 105, + "line": 109, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L105" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L109" } ], "type": { @@ -348,7 +348,7 @@ } }, { - "id": 645, + "id": 687, "name": "TIMED_OUT", "variant": "declaration", "kind": 16, @@ -356,9 +356,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 106, + "line": 110, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L106" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L110" } ], "type": { @@ -370,15 +370,15 @@ "groups": [ { "title": "Enumeration Members", - "children": [647, 646, 644, 645] + "children": [689, 688, 686, 687] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 104, + "line": 108, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L108" } ] }, @@ -406,9 +406,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 147, + "line": 151, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" } ], "signatures": [ @@ -421,9 +421,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 147, + "line": 151, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" } ], "parameters": [ @@ -454,7 +454,7 @@ "flags": {}, "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -468,7 +468,7 @@ "flags": {}, "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -494,9 +494,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 132, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" } ], "type": { @@ -510,9 +510,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 132, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" } ], "indexSignatures": [ @@ -525,9 +525,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 133, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" } ], "parameters": [ @@ -563,9 +563,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 136, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L132" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L136" } ], "type": { @@ -587,9 +587,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "type": { @@ -603,9 +603,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "indexSignatures": [ @@ -618,9 +618,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "parameters": [ @@ -656,9 +656,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 133, + "line": 137, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L133" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L137" } ], "type": { @@ -675,9 +675,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 134, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L130" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L134" } ], "type": { @@ -695,9 +695,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 133, "character": 19, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" } ] } @@ -718,9 +718,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 143, + "line": 147, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L143" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L147" } ], "type": { @@ -737,9 +737,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 138, + "line": 142, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L138" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L142" } ], "type": { @@ -757,9 +757,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 139, + "line": 143, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L139" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L143" } ], "type": { @@ -784,14 +784,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 150, + "line": 154, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L154" } ], "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -806,9 +806,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 142, + "line": 146, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L142" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L146" } ], "type": { @@ -828,9 +828,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 145, + "line": 149, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L145" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L149" } ], "type": { @@ -847,9 +847,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 141, + "line": 145, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L141" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L145" } ], "type": { @@ -876,9 +876,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 140, + "line": 144, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L140" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L144" } ], "type": { @@ -903,14 +903,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 151, + "line": 155, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L151" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L155" } ], "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -925,9 +925,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 137, + "line": 141, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L137" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L141" } ], "type": { @@ -950,9 +950,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 144, + "line": 148, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L144" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L148" } ], "type": { @@ -969,9 +969,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 136, + "line": 140, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L136" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L140" } ], "type": { @@ -998,9 +998,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 149, + "line": 153, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L149" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L153" } ], "type": { @@ -1017,69 +1017,69 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 355, + "line": 370, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" }, { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" }, { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" }, { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" }, { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" }, { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" }, { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" }, { "fileName": "src/RealtimeChannel.ts", - "line": 396, + "line": 411, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" }, { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" }, { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" }, { "fileName": "src/RealtimeChannel.ts", - "line": 419, + "line": 434, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L419" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L434" } ], "signatures": [ @@ -1100,9 +1100,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 355, + "line": 370, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" } ], "parameters": [ @@ -1141,9 +1141,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 372, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" } ], "type": { @@ -1161,9 +1161,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 372, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" } ] } @@ -1186,9 +1186,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 373, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" } ], "signatures": [ @@ -1201,9 +1201,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 373, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" } ], "type": { @@ -1241,9 +1241,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "typeParameters": [ @@ -1264,9 +1264,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "indexSignatures": [ @@ -1279,9 +1279,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "parameters": [ @@ -1343,9 +1343,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 362, + "line": 377, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" } ], "type": { @@ -1363,9 +1363,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 362, + "line": 377, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" } ] } @@ -1388,9 +1388,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 378, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" } ], "signatures": [ @@ -1403,9 +1403,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 378, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" } ], "parameters": [ @@ -1417,7 +1417,7 @@ "flags": {}, "type": { "type": "reference", - "target": 599, + "target": 641, "typeArguments": [ { "type": "reference", @@ -1467,9 +1467,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "typeParameters": [ @@ -1490,9 +1490,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "indexSignatures": [ @@ -1505,9 +1505,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "parameters": [ @@ -1569,9 +1569,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 367, + "line": 382, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" } ], "type": { @@ -1589,9 +1589,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 367, + "line": 382, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" } ] } @@ -1614,9 +1614,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, + "line": 383, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" } ], "signatures": [ @@ -1629,9 +1629,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, + "line": 383, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" } ], "parameters": [ @@ -1643,7 +1643,7 @@ "flags": {}, "type": { "type": "reference", - "target": 609, + "target": 651, "typeArguments": [ { "type": "reference", @@ -1693,9 +1693,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "typeParameters": [ @@ -1716,9 +1716,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "indexSignatures": [ @@ -1731,9 +1731,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "parameters": [ @@ -1779,7 +1779,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -1807,9 +1807,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, + "line": 388, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" } ], "signatures": [ @@ -1822,9 +1822,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, + "line": 388, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" } ], "parameters": [ @@ -1836,7 +1836,7 @@ "flags": {}, "type": { "type": "reference", - "target": 565, + "target": 607, "typeArguments": [ { "type": "reference", @@ -1886,9 +1886,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "typeParameters": [ @@ -1909,9 +1909,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "indexSignatures": [ @@ -1924,9 +1924,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "parameters": [ @@ -1972,7 +1972,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2000,9 +2000,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, + "line": 393, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" } ], "signatures": [ @@ -2015,9 +2015,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, + "line": 393, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" } ], "parameters": [ @@ -2029,7 +2029,7 @@ "flags": {}, "type": { "type": "reference", - "target": 570, + "target": 612, "typeArguments": [ { "type": "reference", @@ -2079,9 +2079,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "typeParameters": [ @@ -2102,9 +2102,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "indexSignatures": [ @@ -2117,9 +2117,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "parameters": [ @@ -2165,7 +2165,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2193,9 +2193,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 383, + "line": 398, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" } ], "signatures": [ @@ -2208,9 +2208,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 383, + "line": 398, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" } ], "parameters": [ @@ -2222,7 +2222,7 @@ "flags": {}, "type": { "type": "reference", - "target": 580, + "target": 622, "typeArguments": [ { "type": "reference", @@ -2272,9 +2272,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "typeParameters": [ @@ -2295,9 +2295,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "indexSignatures": [ @@ -2310,9 +2310,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "parameters": [ @@ -2358,7 +2358,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2386,9 +2386,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 388, + "line": 403, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" } ], "signatures": [ @@ -2401,9 +2401,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 388, + "line": 403, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" } ], "parameters": [ @@ -2415,7 +2415,7 @@ "flags": {}, "type": { "type": "reference", - "target": 589, + "target": 631, "typeArguments": [ { "type": "reference", @@ -2465,9 +2465,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 396, + "line": 411, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" } ], "parameters": [ @@ -2522,9 +2522,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 398, + "line": 413, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" } ], "type": { @@ -2542,9 +2542,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 398, + "line": 413, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" } ] } @@ -2575,9 +2575,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "signatures": [ @@ -2590,9 +2590,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "parameters": [ @@ -2620,9 +2620,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 401, + "line": 416, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L401" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L416" } ], "type": { @@ -2639,9 +2639,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 400, + "line": 415, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L400" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L415" } ], "type": { @@ -2659,9 +2659,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "indexSignatures": [ @@ -2674,9 +2674,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 402, + "line": 417, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L402" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L417" } ], "parameters": [ @@ -2737,9 +2737,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "typeParameters": [ @@ -2760,9 +2760,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "indexSignatures": [ @@ -2775,9 +2775,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "parameters": [ @@ -2839,9 +2839,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 407, + "line": 422, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ], "type": { @@ -2859,9 +2859,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 407, + "line": 422, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ] } @@ -2884,9 +2884,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ], "signatures": [ @@ -2899,9 +2899,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ], "parameters": [ @@ -2929,9 +2929,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 410, + "line": 425, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L410" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L425" } ], "type": { @@ -2948,9 +2948,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 411, + "line": 426, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L411" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L426" } ], "type": { @@ -2970,9 +2970,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 409, + "line": 424, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L409" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L424" } ], "type": { @@ -2990,9 +2990,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ] } @@ -3034,9 +3034,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "typeParameters": [ @@ -3057,9 +3057,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "indexSignatures": [ @@ -3072,9 +3072,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "parameters": [ @@ -3146,9 +3146,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 417, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "signatures": [ @@ -3161,9 +3161,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 417, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "parameters": [ @@ -3208,9 +3208,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 320, + "line": 335, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" } ], "signatures": [ @@ -3223,9 +3223,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 320, + "line": 335, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" } ], "typeParameters": [ @@ -3246,9 +3246,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 321, + "line": 336, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "indexSignatures": [ @@ -3261,9 +3261,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 321, + "line": 336, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "parameters": [ @@ -3301,7 +3301,7 @@ ], "type": { "type": "reference", - "target": 619, + "target": 661, "typeArguments": [ { "type": "reference", @@ -3326,9 +3326,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 445, + "line": 460, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" } ], "signatures": [ @@ -3349,9 +3349,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 445, + "line": 460, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" } ], "parameters": [ @@ -3395,9 +3395,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 448, + "line": 463, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L448" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L463" } ], "type": { @@ -3424,9 +3424,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 449, + "line": 464, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L449" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L464" } ], "type": { @@ -3451,9 +3451,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 447, + "line": 462, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L447" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L462" } ], "type": { @@ -3484,9 +3484,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 446, + "line": 461, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L446" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L461" } ], "indexSignatures": [ @@ -3499,9 +3499,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 450, + "line": 465, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L450" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L465" } ], "parameters": [ @@ -3551,9 +3551,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 452, + "line": 467, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" } ], "indexSignatures": [ @@ -3566,9 +3566,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 452, + "line": 467, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" } ], "parameters": [ @@ -3604,7 +3604,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -3624,9 +3624,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 213, + "line": 225, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" } ], "signatures": [ @@ -3647,9 +3647,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 213, + "line": 225, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" } ], "parameters": [ @@ -3672,9 +3672,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 214, + "line": 226, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "signatures": [ @@ -3687,9 +3687,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 214, + "line": 226, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "parameters": [ @@ -3701,7 +3701,7 @@ "flags": {}, "type": { "type": "reference", - "target": 643, + "target": 685, "name": "REALTIME_SUBSCRIBE_STATES", "package": "@supabase/realtime-js" } @@ -3766,9 +3766,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 561, + "line": 576, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" } ], "signatures": [ @@ -3789,9 +3789,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 561, + "line": 576, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" } ], "type": { @@ -3810,9 +3810,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 326, + "line": 341, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" } ], "signatures": [ @@ -3825,9 +3825,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 326, + "line": 341, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" } ], "parameters": [ @@ -3848,9 +3848,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 327, + "line": 342, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "indexSignatures": [ @@ -3863,9 +3863,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 327, + "line": 342, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "parameters": [ @@ -3907,9 +3907,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 328, + "line": 343, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], "indexSignatures": [ @@ -3922,9 +3922,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 328, + "line": 343, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], "parameters": [ @@ -3960,7 +3960,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -3980,9 +3980,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 522, + "line": 537, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" } ], "signatures": [ @@ -4011,9 +4011,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 522, + "line": 537, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" } ], "parameters": [ @@ -4070,9 +4070,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 340, + "line": 355, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" } ], "signatures": [ @@ -4085,9 +4085,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 340, + "line": 355, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" } ], "parameters": [ @@ -4108,9 +4108,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 341, + "line": 356, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "indexSignatures": [ @@ -4123,9 +4123,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 341, + "line": 356, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "parameters": [ @@ -4161,7 +4161,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -4181,9 +4181,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "signatures": [ @@ -4196,9 +4196,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "parameters": [ @@ -4219,9 +4219,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 29, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "indexSignatures": [ @@ -4234,9 +4234,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "parameters": [ @@ -4287,21 +4287,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 131, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L131" } ] }, { - "id": 369, + "id": 372, "name": "RealtimeClient", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 370, + "id": 373, "name": "constructor", "variant": "declaration", "kind": 512, @@ -4309,14 +4309,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 171, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" } ], "signatures": [ { - "id": 371, + "id": 374, "name": "RealtimeClient", "variant": "signature", "kind": 16384, @@ -4332,14 +4332,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 171, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" } ], "parameters": [ { - "id": 372, + "id": 375, "name": "endPoint", "variant": "param", "kind": 32768, @@ -4358,7 +4358,7 @@ } }, { - "id": 373, + "id": 376, "name": "options", "variant": "param", "kind": 32768, @@ -4367,7 +4367,7 @@ }, "type": { "type": "reference", - "target": 526, + "target": 564, "name": "RealtimeClientOptions", "package": "@supabase/realtime-js", "highlightedProperties": { @@ -4401,6 +4401,12 @@ "text": "The millisec interval to send a heartbeat message." } ], + "heartbeatCallback": [ + { + "kind": "text", + "text": "The optional function to handle heartbeat status." + } + ], "logger": [ { "kind": "text", @@ -4457,7 +4463,7 @@ ], "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -4466,7 +4472,7 @@ ] }, { - "id": 420, + "id": 423, "name": "accessToken", "variant": "declaration", "kind": 1024, @@ -4474,9 +4480,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "type": { @@ -4489,7 +4495,7 @@ { "type": "reflection", "declaration": { - "id": 421, + "id": 424, "name": "__type", "variant": "declaration", "kind": 65536, @@ -4497,14 +4503,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "signatures": [ { - "id": 422, + "id": 425, "name": "__type", "variant": "signature", "kind": 4096, @@ -4512,9 +4518,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "type": { @@ -4550,7 +4556,7 @@ "defaultValue": "null" }, { - "id": 374, + "id": 377, "name": "accessTokenValue", "variant": "declaration", "kind": 1024, @@ -4558,9 +4564,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 91, + "line": 108, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L91" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L108" } ], "type": { @@ -4579,7 +4585,7 @@ "defaultValue": "null" }, { - "id": 375, + "id": 378, "name": "apiKey", "variant": "declaration", "kind": 1024, @@ -4587,9 +4593,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 92, + "line": 109, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L92" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L109" } ], "type": { @@ -4608,7 +4614,7 @@ "defaultValue": "null" }, { - "id": 376, + "id": 379, "name": "channels", "variant": "declaration", "kind": 1024, @@ -4616,9 +4622,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, + "line": 110, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L93" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L110" } ], "type": { @@ -4634,7 +4640,7 @@ "defaultValue": "..." }, { - "id": 403, + "id": 406, "name": "conn", "variant": "declaration", "kind": 1024, @@ -4642,9 +4648,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 129, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L112" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L129" } ], "type": { @@ -4656,19 +4662,16 @@ }, { "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } ] }, "defaultValue": "null" }, { - "id": 401, + "id": 404, "name": "decode", "variant": "declaration", "kind": 1024, @@ -4676,9 +4679,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 110, + "line": 127, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L110" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L127" } ], "type": { @@ -4692,7 +4695,7 @@ } }, { - "id": 400, + "id": 403, "name": "encode", "variant": "declaration", "kind": 1024, @@ -4700,9 +4703,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 109, + "line": 126, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L109" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L126" } ], "type": { @@ -4716,7 +4719,7 @@ } }, { - "id": 377, + "id": 380, "name": "endPoint", "variant": "declaration", "kind": 1024, @@ -4724,9 +4727,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 94, + "line": 111, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L94" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L111" } ], "type": { @@ -4736,7 +4739,7 @@ "defaultValue": "''" }, { - "id": 412, + "id": 415, "name": "fetch", "variant": "declaration", "kind": 1024, @@ -4744,15 +4747,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 126, + "line": 143, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L126" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L143" } ], "type": { "type": "reflection", "declaration": { - "id": 413, + "id": 416, "name": "__type", "variant": "declaration", "kind": 65536, @@ -4771,7 +4774,7 @@ ], "signatures": [ { - "id": 414, + "id": 417, "name": "__type", "variant": "signature", "kind": 4096, @@ -4793,7 +4796,7 @@ ], "parameters": [ { - "id": 415, + "id": 418, "name": "input", "variant": "param", "kind": 32768, @@ -4823,7 +4826,7 @@ } }, { - "id": 416, + "id": 419, "name": "init", "variant": "param", "kind": 32768, @@ -4863,7 +4866,7 @@ } }, { - "id": 417, + "id": 420, "name": "__type", "variant": "signature", "kind": 4096, @@ -4885,7 +4888,7 @@ ], "parameters": [ { - "id": 418, + "id": 421, "name": "input", "variant": "param", "kind": 32768, @@ -4919,7 +4922,7 @@ } }, { - "id": 419, + "id": 422, "name": "init", "variant": "param", "kind": 32768, @@ -4963,7 +4966,7 @@ } }, { - "id": 379, + "id": 382, "name": "headers", "variant": "declaration", "kind": 1024, @@ -4987,15 +4990,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "type": { "type": "reflection", "declaration": { - "id": 380, + "id": 383, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5003,14 +5006,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "indexSignatures": [ { - "id": 381, + "id": 384, "name": "__index", "variant": "signature", "kind": 8192, @@ -5018,14 +5021,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "parameters": [ { - "id": 382, + "id": 385, "name": "key", "variant": "param", "kind": 32768, @@ -5047,7 +5050,7 @@ "defaultValue": "{}" }, { - "id": 392, + "id": 395, "name": "heartbeatCallback", "variant": "declaration", "kind": 1024, @@ -5055,15 +5058,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 396, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5071,14 +5074,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "signatures": [ { - "id": 394, + "id": 397, "name": "__type", "variant": "signature", "kind": 4096, @@ -5086,14 +5089,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "parameters": [ { - "id": 395, + "id": 398, "name": "status", "variant": "param", "kind": 32768, @@ -5120,7 +5123,7 @@ "defaultValue": "noop" }, { - "id": 389, + "id": 392, "name": "heartbeatIntervalMs", "variant": "declaration", "kind": 1024, @@ -5128,19 +5131,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 101, + "line": 118, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L101" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L118" } ], "type": { "type": "intrinsic", "name": "number" }, - "defaultValue": "25000" + "defaultValue": "CONNECTION_TIMEOUTS.HEARTBEAT_INTERVAL" }, { - "id": 390, + "id": 393, "name": "heartbeatTimer", "variant": "declaration", "kind": 1024, @@ -5148,9 +5151,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 102, + "line": 119, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L102" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L119" } ], "type": { @@ -5175,7 +5178,7 @@ "defaultValue": "undefined" }, { - "id": 378, + "id": 381, "name": "httpEndpoint", "variant": "declaration", "kind": 1024, @@ -5183,9 +5186,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 95, + "line": 112, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L95" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L112" } ], "type": { @@ -5195,7 +5198,7 @@ "defaultValue": "''" }, { - "id": 398, + "id": 401, "name": "logger", "variant": "declaration", "kind": 1024, @@ -5203,9 +5206,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 107, + "line": 124, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L107" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L124" } ], "type": { @@ -5220,7 +5223,7 @@ "defaultValue": "noop" }, { - "id": 399, + "id": 402, "name": "logLevel", "variant": "declaration", "kind": 1024, @@ -5230,9 +5233,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 108, + "line": 125, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L108" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L125" } ], "type": { @@ -5246,7 +5249,7 @@ } }, { - "id": 383, + "id": 386, "name": "params", "variant": "declaration", "kind": 1024, @@ -5256,15 +5259,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "type": { "type": "reflection", "declaration": { - "id": 384, + "id": 387, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5272,14 +5275,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "indexSignatures": [ { - "id": 385, + "id": 388, "name": "__index", "variant": "signature", "kind": 8192, @@ -5287,14 +5290,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "parameters": [ { - "id": 386, + "id": 389, "name": "key", "variant": "param", "kind": 32768, @@ -5316,7 +5319,7 @@ "defaultValue": "{}" }, { - "id": 391, + "id": 394, "name": "pendingHeartbeatRef", "variant": "declaration", "kind": 1024, @@ -5324,9 +5327,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 103, + "line": 120, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L103" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L120" } ], "type": { @@ -5345,7 +5348,7 @@ "defaultValue": "null" }, { - "id": 402, + "id": 405, "name": "reconnectAfterMs", "variant": "declaration", "kind": 1024, @@ -5353,9 +5356,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 111, + "line": 128, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L111" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L128" } ], "type": { @@ -5369,7 +5372,7 @@ } }, { - "id": 397, + "id": 400, "name": "reconnectTimer", "variant": "declaration", "kind": 1024, @@ -5377,24 +5380,34 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 106, + "line": 123, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L106" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L123" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/timer.ts", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + ] + }, + "defaultValue": "null" }, { - "id": 396, + "id": 399, "name": "ref", "variant": "declaration", "kind": 1024, @@ -5402,9 +5415,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 105, + "line": 122, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L105" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L122" } ], "type": { @@ -5414,7 +5427,7 @@ "defaultValue": "0" }, { - "id": 404, + "id": 407, "name": "sendBuffer", "variant": "declaration", "kind": 1024, @@ -5422,9 +5435,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 113, + "line": 130, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L113" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L130" } ], "type": { @@ -5442,7 +5455,7 @@ "defaultValue": "[]" }, { - "id": 405, + "id": 408, "name": "serializer", "variant": "declaration", "kind": 1024, @@ -5450,9 +5463,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 114, + "line": 131, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L114" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L131" } ], "type": { @@ -5468,7 +5481,7 @@ "defaultValue": "..." }, { - "id": 406, + "id": 409, "name": "stateChangeCallbacks", "variant": "declaration", "kind": 1024, @@ -5476,22 +5489,22 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, + "line": 132, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" } ], "type": { "type": "reflection", "declaration": { - "id": 407, + "id": 410, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 409, + "id": 412, "name": "close", "variant": "declaration", "kind": 1024, @@ -5499,9 +5512,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 117, + "line": 134, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L117" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L134" } ], "type": { @@ -5518,7 +5531,7 @@ } }, { - "id": 410, + "id": 413, "name": "error", "variant": "declaration", "kind": 1024, @@ -5526,9 +5539,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 118, + "line": 135, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L118" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L135" } ], "type": { @@ -5545,7 +5558,7 @@ } }, { - "id": 411, + "id": 414, "name": "message", "variant": "declaration", "kind": 1024, @@ -5553,9 +5566,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 119, + "line": 136, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L119" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L136" } ], "type": { @@ -5572,7 +5585,7 @@ } }, { - "id": 408, + "id": 411, "name": "open", "variant": "declaration", "kind": 1024, @@ -5580,9 +5593,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 116, + "line": 133, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L116" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L133" } ], "type": { @@ -5602,15 +5615,15 @@ "groups": [ { "title": "Properties", - "children": [409, 410, 411, 408] + "children": [412, 413, 414, 411] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, + "line": 132, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" } ] } @@ -5618,7 +5631,7 @@ "defaultValue": "..." }, { - "id": 387, + "id": 390, "name": "timeout", "variant": "declaration", "kind": 1024, @@ -5626,9 +5639,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 99, + "line": 116, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L99" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L116" } ], "type": { @@ -5638,7 +5651,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 388, + "id": 391, "name": "transport", "variant": "declaration", "kind": 1024, @@ -5646,9 +5659,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 100, + "line": 117, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L100" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L117" } ], "type": { @@ -5660,18 +5673,16 @@ }, { "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, + "target": 758, "name": "WebSocketLikeConstructor", "package": "@supabase/realtime-js" } ] - } + }, + "defaultValue": "null" }, { - "id": 423, + "id": 426, "name": "worker", "variant": "declaration", "kind": 1024, @@ -5681,9 +5692,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 128, + "line": 145, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L145" } ], "type": { @@ -5692,7 +5703,7 @@ } }, { - "id": 425, + "id": 428, "name": "workerRef", "variant": "declaration", "kind": 1024, @@ -5702,9 +5713,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 130, + "line": 147, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L130" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L147" } ], "type": { @@ -5718,7 +5729,7 @@ } }, { - "id": 424, + "id": 427, "name": "workerUrl", "variant": "declaration", "kind": 1024, @@ -5728,9 +5739,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 129, + "line": 146, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L146" } ], "type": { @@ -5739,7 +5750,7 @@ } }, { - "id": 450, + "id": 460, "name": "channel", "variant": "declaration", "kind": 2048, @@ -5747,14 +5758,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 328, + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], "signatures": [ { - "id": 451, + "id": 461, "name": "channel", "variant": "signature", "kind": 4096, @@ -5762,14 +5773,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 328, + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], "parameters": [ { - "id": 452, + "id": 462, "name": "topic", "variant": "param", "kind": 32768, @@ -5780,14 +5791,14 @@ } }, { - "id": 453, + "id": 463, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -5805,7 +5816,7 @@ ] }, { - "id": 426, + "id": 432, "name": "connect", "variant": "declaration", "kind": 2048, @@ -5813,14 +5824,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 207, + "line": 190, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], "signatures": [ { - "id": 427, + "id": 433, "name": "connect", "variant": "signature", "kind": 4096, @@ -5836,9 +5847,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 207, + "line": 190, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], "type": { @@ -5849,7 +5860,7 @@ ] }, { - "id": 446, + "id": 452, "name": "connectionState", "variant": "declaration", "kind": 2048, @@ -5857,14 +5868,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, + "line": 331, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" } ], "signatures": [ { - "id": 447, + "id": 453, "name": "connectionState", "variant": "signature", "kind": 4096, @@ -5880,9 +5891,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, + "line": 331, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" } ], "type": { @@ -5898,7 +5909,7 @@ ] }, { - "id": 430, + "id": 436, "name": "disconnect", "variant": "declaration", "kind": 2048, @@ -5906,14 +5917,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 244, + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "signatures": [ { - "id": 431, + "id": 437, "name": "disconnect", "variant": "signature", "kind": 4096, @@ -5929,14 +5940,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 244, + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "parameters": [ { - "id": 432, + "id": 438, "name": "code", "variant": "param", "kind": 32768, @@ -5957,7 +5968,7 @@ } }, { - "id": 433, + "id": 439, "name": "reason", "variant": "param", "kind": 32768, @@ -5986,7 +5997,7 @@ ] }, { - "id": 428, + "id": 434, "name": "endpointURL", "variant": "declaration", "kind": 2048, @@ -5994,14 +6005,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 231, + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "signatures": [ { - "id": 429, + "id": 435, "name": "endpointURL", "variant": "signature", "kind": 4096, @@ -6028,9 +6039,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 231, + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "type": { @@ -6041,7 +6052,7 @@ ] }, { - "id": 468, + "id": 478, "name": "flushSendBuffer", "variant": "declaration", "kind": 2048, @@ -6049,14 +6060,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 435, + "line": 482, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], "signatures": [ { - "id": 469, + "id": 479, "name": "flushSendBuffer", "variant": "signature", "kind": 4096, @@ -6072,9 +6083,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 435, + "line": 482, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], "type": { @@ -6085,7 +6096,7 @@ ] }, { - "id": 434, + "id": 440, "name": "getChannels", "variant": "declaration", "kind": 2048, @@ -6093,14 +6104,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 264, + "line": 287, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" } ], "signatures": [ { - "id": 435, + "id": 441, "name": "getChannels", "variant": "signature", "kind": 4096, @@ -6116,9 +6127,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 264, + "line": 287, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" } ], "type": { @@ -6135,7 +6146,7 @@ ] }, { - "id": 448, + "id": 454, "name": "isConnected", "variant": "declaration", "kind": 2048, @@ -6143,14 +6154,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 324, + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "signatures": [ { - "id": 449, + "id": 455, "name": "isConnected", "variant": "signature", "kind": 4096, @@ -6174,9 +6185,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 324, + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "type": { @@ -6187,23 +6198,23 @@ ] }, { - "id": 441, - "name": "log", + "id": 456, + "name": "isConnecting", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 301, + "line": 354, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], "signatures": [ { - "id": 442, - "name": "log", + "id": 457, + "name": "isConnecting", "variant": "signature", "kind": 4096, "flags": {}, @@ -6211,40 +6222,144 @@ "summary": [ { "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " + "text": "Returns " }, { "kind": "code", - "text": "`this.logger`" + "text": "`true`" }, { "kind": "text", - "text": " can be overridden." + "text": " if the connection is currently connecting." } ] }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 301, + "line": 354, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], - "parameters": [ - { - "id": 443, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 458, + "name": "isDisconnecting", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 361, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" + } + ], + "signatures": [ + { + "id": 459, + "name": "isDisconnecting", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " if the connection is currently disconnecting." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 361, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 447, + "name": "log", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 324, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" + } + ], + "signatures": [ + { + "id": 448, + "name": "log", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 324, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" + } + ], + "parameters": [ + { + "id": 449, + "name": "kind", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", "name": "string" } }, { - "id": 444, + "id": 450, "name": "msg", "variant": "param", "kind": 32768, @@ -6255,7 +6370,7 @@ } }, { - "id": 445, + "id": 451, "name": "data", "variant": "param", "kind": 32768, @@ -6276,7 +6391,7 @@ ] }, { - "id": 462, + "id": 472, "name": "onHeartbeat", "variant": "declaration", "kind": 2048, @@ -6284,14 +6399,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "signatures": [ { - "id": 463, + "id": 473, "name": "onHeartbeat", "variant": "signature", "kind": 4096, @@ -6299,14 +6414,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "parameters": [ { - "id": 464, + "id": 474, "name": "callback", "variant": "param", "kind": 32768, @@ -6314,7 +6429,7 @@ "type": { "type": "reflection", "declaration": { - "id": 465, + "id": 475, "name": "__type", "variant": "declaration", "kind": 65536, @@ -6322,14 +6437,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "signatures": [ { - "id": 466, + "id": 476, "name": "__type", "variant": "signature", "kind": 4096, @@ -6337,14 +6452,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "parameters": [ { - "id": 467, + "id": 477, "name": "status", "variant": "param", "kind": 32768, @@ -6378,7 +6493,7 @@ ] }, { - "id": 454, + "id": 464, "name": "push", "variant": "declaration", "kind": 2048, @@ -6386,14 +6501,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 352, + "line": 389, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" } ], "signatures": [ { - "id": 455, + "id": 465, "name": "push", "variant": "signature", "kind": 4096, @@ -6409,21 +6524,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 352, + "line": 389, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" } ], "parameters": [ { - "id": 456, + "id": 466, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 551, + "target": 593, "name": "RealtimeMessage", "package": "@supabase/realtime-js" } @@ -6437,7 +6552,7 @@ ] }, { - "id": 439, + "id": 445, "name": "removeAllChannels", "variant": "declaration", "kind": 2048, @@ -6445,14 +6560,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 287, + "line": 310, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" } ], "signatures": [ { - "id": 440, + "id": 446, "name": "removeAllChannels", "variant": "signature", "kind": 4096, @@ -6468,9 +6583,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 287, + "line": 310, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" } ], "type": { @@ -6484,7 +6599,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 628, + "target": 670, "name": "RealtimeRemoveChannelResponse", "package": "@supabase/realtime-js" } @@ -6497,7 +6612,7 @@ ] }, { - "id": 436, + "id": 442, "name": "removeChannel", "variant": "declaration", "kind": 2048, @@ -6505,14 +6620,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 272, + "line": 295, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], "signatures": [ { - "id": 437, + "id": 443, "name": "removeChannel", "variant": "signature", "kind": 4096, @@ -6528,14 +6643,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 272, + "line": 295, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], "parameters": [ { - "id": 438, + "id": 444, "name": "channel", "variant": "param", "kind": 32768, @@ -6566,7 +6681,7 @@ "typeArguments": [ { "type": "reference", - "target": 628, + "target": 670, "name": "RealtimeRemoveChannelResponse", "package": "@supabase/realtime-js" } @@ -6578,7 +6693,7 @@ ] }, { - "id": 460, + "id": 470, "name": "sendHeartbeat", "variant": "declaration", "kind": 2048, @@ -6586,14 +6701,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 403, + "line": 424, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], "signatures": [ { - "id": 461, + "id": 471, "name": "sendHeartbeat", "variant": "signature", "kind": 4096, @@ -6609,9 +6724,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 403, + "line": 424, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], "type": { @@ -6633,7 +6748,7 @@ ] }, { - "id": 457, + "id": 467, "name": "setAuth", "variant": "declaration", "kind": 2048, @@ -6641,14 +6756,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 376, + "line": 413, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], "signatures": [ { - "id": 458, + "id": 468, "name": "setAuth", "variant": "signature", "kind": 4096, @@ -6672,14 +6787,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 376, + "line": 413, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], "parameters": [ { - "id": 459, + "id": 469, "name": "token", "variant": "param", "kind": 32768, @@ -6730,26 +6845,28 @@ "groups": [ { "title": "Constructors", - "children": [370] + "children": [373] }, { "title": "Properties", "children": [ - 420, 374, 375, 376, 403, 401, 400, 377, 412, 379, 392, 389, 390, 378, 398, 399, 383, - 391, 402, 397, 396, 404, 405, 406, 387, 388, 423, 425, 424 + 423, 377, 378, 379, 406, 404, 403, 380, 415, 382, 395, 392, 393, 381, 401, 402, 386, + 394, 405, 400, 399, 407, 408, 409, 390, 391, 426, 428, 427 ] }, { "title": "Methods", - "children": [450, 426, 446, 430, 428, 468, 434, 448, 441, 462, 454, 439, 436, 460, 457] + "children": [ + 460, 432, 452, 436, 434, 478, 440, 454, 456, 458, 447, 472, 464, 445, 442, 470, 467 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 90, + "line": 107, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L90" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L107" } ] }, @@ -6771,7 +6888,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "signatures": [ @@ -6794,7 +6911,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "parameters": [ @@ -6872,7 +6989,7 @@ "fileName": "src/RealtimePresence.ts", "line": 68, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" } ], "type": { @@ -6895,7 +7012,7 @@ "fileName": "src/RealtimePresence.ts", "line": 69, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L69" } ], "type": { @@ -6919,7 +7036,7 @@ "fileName": "src/RealtimePresence.ts", "line": 70, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L70" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L70" } ], "type": { @@ -6943,7 +7060,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "type": { @@ -6959,7 +7076,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "signatures": [ @@ -6974,7 +7091,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "type": { @@ -6998,7 +7115,7 @@ "fileName": "src/RealtimePresence.ts", "line": 68, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" } ] } @@ -7026,7 +7143,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "type": { @@ -7048,7 +7165,7 @@ "fileName": "src/RealtimePresence.ts", "line": 67, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L67" } ], "type": { @@ -7068,7 +7185,7 @@ "fileName": "src/RealtimePresence.ts", "line": 66, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L66" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L66" } ], "type": { @@ -7097,7 +7214,7 @@ "fileName": "src/RealtimePresence.ts", "line": 65, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L65" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L65" } ], "type": { @@ -7125,12 +7242,12 @@ "fileName": "src/RealtimePresence.ts", "line": 64, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "target": 619, + "target": 661, "name": "RealtimePresenceState", "package": "@supabase/realtime-js" }, @@ -7152,91 +7269,1513 @@ "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L63" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L63" } ] }, { - "id": 355, - "name": "RealtimeChannelOptions", + "id": 691, + "name": "WebSocketFactory", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 356, - "name": "__type", + "id": 706, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 357, - "name": "config", - "variant": "declaration", - "kind": 1024, + "id": 707, + "name": "WebSocketFactory", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 691, + "name": "WebSocketFactory", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 700, + "name": "createWebSocket", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" + } + ], + "signatures": [ + { + "id": 701, + "name": "createWebSocket", + "variant": "signature", + "kind": 4096, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" + } + ], + "parameters": [ + { + "id": 702, + "name": "url", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 703, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 694, + "name": "getWebSocketConstructor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" + } + ], + "signatures": [ + { + "id": 695, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" } ], "type": { "type": "reflection", "declaration": { - "id": 358, + "id": 696, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, - "children": [ + "sources": [ { - "id": 359, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - } - ] - }, + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26772, + "character": 23 + } + ], + "signatures": [ + { + "id": 697, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26774, + "character": 4 + } + ], + "parameters": [ + { + "id": 698, + "name": "url", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 699, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "WebSocket" + }, + "name": "WebSocket", + "package": "typescript" + } + } + ] + } + } + } + ] + }, + { + "id": 704, + "name": "isWebSocketSupported", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" + } + ], + "signatures": [ + { + "id": 705, + "name": "isWebSocketSupported", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [706] + }, + { + "title": "Methods", + "children": [700, 694, 704] + } + ], + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 35, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L35" + } + ] + }, + { + "id": 708, + "name": "WebSocketLike", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 751, + "name": "binaryType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L22" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 752, + "name": "bufferedAmount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L23" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 712, + "name": "CLOSED", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 5, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L5" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 711, + "name": "CLOSING", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 4, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L4" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 709, + "name": "CONNECTING", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 2, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L2" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 754, + "name": "dispatchEvent", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 755, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "signatures": [ + { + "id": 756, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "parameters": [ + { + "id": 757, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + } + } + }, + { + "id": 753, + "name": "extensions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L24" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 733, + "name": "onclose", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 734, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "signatures": [ + { + "id": 735, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "parameters": [ + { + "id": 736, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 737, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "CloseEvent" + }, + "name": "CloseEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 738, + "name": "onerror", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 739, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "signatures": [ + { + "id": 740, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "parameters": [ + { + "id": 741, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 742, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 728, + "name": "onmessage", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 729, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "signatures": [ + { + "id": 730, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "parameters": [ + { + "id": 731, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 732, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "MessageEvent" + }, + "name": "MessageEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 723, + "name": "onopen", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 724, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "signatures": [ + { + "id": 725, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "parameters": [ + { + "id": 726, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 727, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 710, + "name": "OPEN", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 3, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L3" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 715, + "name": "protocol", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 8, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L8" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 713, + "name": "readyState", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 6, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L6" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 714, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 7, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L7" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 743, + "name": "addEventListener", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" + } + ], + "signatures": [ + { + "id": 744, + "name": "addEventListener", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" + } + ], + "parameters": [ + { + "id": 745, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 746, + "name": "listener", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 716, + "name": "close", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 10, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" + } + ], + "signatures": [ + { + "id": 717, + "name": "close", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 10, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" + } + ], + "parameters": [ + { + "id": 718, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 719, + "name": "reason", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 747, + "name": "removeEventListener", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" + } + ], + "signatures": [ + { + "id": 748, + "name": "removeEventListener", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" + } + ], + "parameters": [ + { + "id": 749, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 750, + "name": "listener", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 720, + "name": "send", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" + } + ], + "signatures": [ + { + "id": 721, + "name": "send", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" + } + ], + "parameters": [ + { + "id": 722, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferView" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + } + ], + "name": "ArrayBufferView", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Blob" + }, + "name": "Blob", + "package": "typescript" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [751, 752, 712, 711, 709, 754, 753, 733, 738, 728, 723, 710, 715, 713, 714] + }, + { + "title": "Methods", + "children": [743, 716, 747, 720] + } + ], + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 1, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L1" + } + ] + }, + { + "id": 758, + "name": "WebSocketLikeConstructor", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 759, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" + } + ], + "signatures": [ + { + "id": 760, + "name": "WebSocketLikeConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 66, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L66" + } + ], + "parameters": [ + { + "id": 761, + "name": "address", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 762, + "name": "subprotocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [759] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" + } + ], + "indexSignatures": [ + { + "id": 763, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 71, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L71" + } + ], + "parameters": [ + { + "id": 764, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + }, + { + "id": 358, + "name": "RealtimeChannelOptions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 20, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 360, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 361, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 362, + "name": "broadcast", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + } + ] + }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 360, + "id": 363, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 362, + "id": 365, "name": "ack", "variant": "declaration", "kind": 1024, @@ -7246,9 +8785,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 34, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -7257,7 +8796,7 @@ } }, { - "id": 361, + "id": 364, "name": "self", "variant": "declaration", "kind": 1024, @@ -7267,9 +8806,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 18, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -7281,22 +8820,22 @@ "groups": [ { "title": "Properties", - "children": [362, 361] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 363, + "id": 366, "name": "presence", "variant": "declaration", "kind": 1024, @@ -7314,22 +8853,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { "type": "reflection", "declaration": { - "id": 364, + "id": 367, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 366, + "id": 369, "name": "enabled", "variant": "declaration", "kind": 1024, @@ -7339,9 +8878,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -7350,7 +8889,7 @@ } }, { - "id": 365, + "id": 368, "name": "key", "variant": "declaration", "kind": 1024, @@ -7360,9 +8899,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -7374,22 +8913,22 @@ "groups": [ { "title": "Properties", - "children": [366, 365] + "children": [369, 368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ] } } }, { - "id": 367, + "id": 370, "name": "private", "variant": "declaration", "kind": 1024, @@ -7407,9 +8946,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 30, + "line": 34, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L34" } ], "type": { @@ -7421,15 +8960,15 @@ "groups": [ { "title": "Properties", - "children": [359, 363, 367] + "children": [362, 366, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 17, + "line": 21, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" } ] } @@ -7439,22 +8978,22 @@ "groups": [ { "title": "Properties", - "children": [357] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 20, "character": 37, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" } ] } } }, { - "id": 368, + "id": 371, "name": "RealtimeChannelSendResponse", "variant": "declaration", "kind": 2097152, @@ -7462,9 +9001,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 92, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L88" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L92" } ], "type": { @@ -7486,7 +9025,7 @@ } }, { - "id": 526, + "id": 564, "name": "RealtimeClientOptions", "variant": "declaration", "kind": 2097152, @@ -7494,22 +9033,22 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 527, + "id": 565, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 548, + "id": 590, "name": "accessToken", "variant": "declaration", "kind": 1024, @@ -7519,15 +9058,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "type": { "type": "reflection", "declaration": { - "id": 549, + "id": 591, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7535,14 +9074,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "signatures": [ { - "id": 550, + "id": 592, "name": "__type", "variant": "signature", "kind": 4096, @@ -7577,7 +9116,7 @@ } }, { - "id": 533, + "id": 575, "name": "decode", "variant": "declaration", "kind": 1024, @@ -7587,9 +9126,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 87, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L70" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L87" } ], "type": { @@ -7603,7 +9142,7 @@ } }, { - "id": 532, + "id": 574, "name": "encode", "variant": "declaration", "kind": 1024, @@ -7613,9 +9152,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 86, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L86" } ], "type": { @@ -7629,7 +9168,7 @@ } }, { - "id": 545, + "id": 587, "name": "fetch", "variant": "declaration", "kind": 1024, @@ -7639,9 +9178,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 94, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L94" } ], "type": { @@ -7655,7 +9194,7 @@ } }, { - "id": 535, + "id": 577, "name": "headers", "variant": "declaration", "kind": 1024, @@ -7665,15 +9204,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "type": { "type": "reflection", "declaration": { - "id": 536, + "id": 578, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7681,14 +9220,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "indexSignatures": [ { - "id": 537, + "id": 579, "name": "__index", "variant": "signature", "kind": 8192, @@ -7696,14 +9235,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "parameters": [ { - "id": 538, + "id": 580, "name": "key", "variant": "param", "kind": 32768, @@ -7724,7 +9263,73 @@ } }, { - "id": 530, + "id": 569, + "name": "heartbeatCallback", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 22, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "signatures": [ + { + "id": 571, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "status", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "HeartbeatStatus" + }, + "name": "HeartbeatStatus", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 568, "name": "heartbeatIntervalMs", "variant": "declaration", "kind": 1024, @@ -7734,9 +9339,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 83, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L83" } ], "type": { @@ -7745,7 +9350,7 @@ } }, { - "id": 543, + "id": 585, "name": "log_level", "variant": "declaration", "kind": 1024, @@ -7755,9 +9360,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 92, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L75" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L92" } ], "type": { @@ -7771,7 +9376,7 @@ } }, { - "id": 531, + "id": 573, "name": "logger", "variant": "declaration", "kind": 1024, @@ -7781,9 +9386,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L85" } ], "type": { @@ -7797,7 +9402,7 @@ } }, { - "id": 544, + "id": 586, "name": "logLevel", "variant": "declaration", "kind": 1024, @@ -7807,9 +9412,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 93, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L76" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L93" } ], "type": { @@ -7823,7 +9428,7 @@ } }, { - "id": 539, + "id": 581, "name": "params", "variant": "declaration", "kind": 1024, @@ -7833,15 +9438,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "type": { "type": "reflection", "declaration": { - "id": 540, + "id": 582, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7849,14 +9454,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "indexSignatures": [ { - "id": 541, + "id": 583, "name": "__index", "variant": "signature", "kind": 8192, @@ -7864,14 +9469,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "parameters": [ { - "id": 542, + "id": 584, "name": "key", "variant": "param", "kind": 32768, @@ -7892,7 +9497,7 @@ } }, { - "id": 534, + "id": 576, "name": "reconnectAfterMs", "variant": "declaration", "kind": 1024, @@ -7902,9 +9507,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 88, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L88" } ], "type": { @@ -7918,7 +9523,7 @@ } }, { - "id": 529, + "id": 567, "name": "timeout", "variant": "declaration", "kind": 1024, @@ -7928,9 +9533,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 82, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L66" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L82" } ], "type": { @@ -7939,7 +9544,7 @@ } }, { - "id": 528, + "id": 566, "name": "transport", "variant": "declaration", "kind": 1024, @@ -7949,23 +9554,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L65" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L81" } ], "type": { "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, + "target": 758, "name": "WebSocketLikeConstructor", "package": "@supabase/realtime-js" } }, { - "id": 546, + "id": 588, "name": "worker", "variant": "declaration", "kind": 1024, @@ -7975,9 +9577,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 95, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L78" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L95" } ], "type": { @@ -7986,7 +9588,7 @@ } }, { - "id": 547, + "id": 589, "name": "workerUrl", "variant": "declaration", "kind": 1024, @@ -7996,9 +9598,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 96, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L79" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L96" } ], "type": { @@ -8011,23 +9613,23 @@ { "title": "Properties", "children": [ - 548, 533, 532, 545, 535, 530, 543, 531, 544, 539, 534, 529, 528, 546, 547 + 590, 575, 574, 587, 577, 569, 568, 585, 573, 586, 581, 576, 567, 566, 588, 589 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 36, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ] } } }, { - "id": 551, + "id": 593, "name": "RealtimeMessage", "variant": "declaration", "kind": 2097152, @@ -8037,20 +9639,20 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 594, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 554, + "id": 596, "name": "event", "variant": "declaration", "kind": 1024, @@ -8060,7 +9662,7 @@ "fileName": "src/RealtimeClient.ts", "line": 33, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L33" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L33" } ], "type": { @@ -8069,7 +9671,7 @@ } }, { - "id": 557, + "id": 599, "name": "join_ref", "variant": "declaration", "kind": 1024, @@ -8081,7 +9683,7 @@ "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L36" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L36" } ], "type": { @@ -8090,7 +9692,7 @@ } }, { - "id": 555, + "id": 597, "name": "payload", "variant": "declaration", "kind": 1024, @@ -8100,7 +9702,7 @@ "fileName": "src/RealtimeClient.ts", "line": 34, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L34" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L34" } ], "type": { @@ -8109,7 +9711,7 @@ } }, { - "id": 556, + "id": 598, "name": "ref", "variant": "declaration", "kind": 1024, @@ -8119,7 +9721,7 @@ "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L35" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L35" } ], "type": { @@ -8128,7 +9730,7 @@ } }, { - "id": 553, + "id": 595, "name": "topic", "variant": "declaration", "kind": 1024, @@ -8138,7 +9740,7 @@ "fileName": "src/RealtimeClient.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L32" } ], "type": { @@ -8150,7 +9752,7 @@ "groups": [ { "title": "Properties", - "children": [554, 557, 555, 556, 553] + "children": [596, 599, 597, 598, 595] } ], "sources": [ @@ -8158,14 +9760,14 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 30, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ] } } }, { - "id": 558, + "id": 600, "name": "RealtimePostgresChangesFilter", "variant": "declaration", "kind": 2097152, @@ -8173,14 +9775,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 67, + "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L71" } ], "typeParameters": [ { - "id": 564, + "id": 606, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8192,7 +9794,7 @@ [ { "type": "reference", - "target": 634, + "target": 676, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "package": "@supabase/realtime-js" }, @@ -8205,14 +9807,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 601, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 560, + "id": 602, "name": "event", "variant": "declaration", "kind": 1024, @@ -8228,21 +9830,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 73, + "line": 77, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L77" } ], "type": { "type": "reference", - "target": 564, + "target": 606, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 563, + "id": 605, "name": "filter", "variant": "declaration", "kind": 1024, @@ -8260,9 +9862,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L89" } ], "type": { @@ -8271,7 +9873,7 @@ } }, { - "id": 561, + "id": 603, "name": "schema", "variant": "declaration", "kind": 1024, @@ -8287,9 +9889,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 77, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L81" } ], "type": { @@ -8298,7 +9900,7 @@ } }, { - "id": 562, + "id": 604, "name": "table", "variant": "declaration", "kind": 1024, @@ -8316,9 +9918,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 81, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L81" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L85" } ], "type": { @@ -8330,22 +9932,22 @@ "groups": [ { "title": "Properties", - "children": [560, 563, 561, 562] + "children": [602, 605, 603, 604] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 69, + "line": 73, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L73" } ] } } }, { - "id": 565, + "id": 607, "name": "RealtimePostgresChangesPayload", "variant": "declaration", "kind": 2097152, @@ -8353,14 +9955,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "typeParameters": [ { - "id": 566, + "id": 608, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8368,7 +9970,7 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 609, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8376,14 +9978,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "indexSignatures": [ { - "id": 568, + "id": 610, "name": "__index", "variant": "signature", "kind": 8192, @@ -8391,14 +9993,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 55, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "parameters": [ { - "id": 569, + "id": 611, "name": "key", "variant": "param", "kind": 32768, @@ -8424,11 +10026,11 @@ "types": [ { "type": "reference", - "target": 570, + "target": 612, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8439,11 +10041,11 @@ }, { "type": "reference", - "target": 580, + "target": 622, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8454,11 +10056,11 @@ }, { "type": "reference", - "target": 589, + "target": 631, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8471,7 +10073,7 @@ } }, { - "id": 589, + "id": 631, "name": "RealtimePostgresDeletePayload", "variant": "declaration", "kind": 2097152, @@ -8479,14 +10081,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "typeParameters": [ { - "id": 595, + "id": 637, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8494,7 +10096,7 @@ "type": { "type": "reflection", "declaration": { - "id": 596, + "id": 638, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8502,14 +10104,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "indexSignatures": [ { - "id": 597, + "id": 639, "name": "__index", "variant": "signature", "kind": 8192, @@ -8517,14 +10119,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "parameters": [ { - "id": 598, + "id": 640, "name": "key", "variant": "param", "kind": 32768, @@ -8560,14 +10162,14 @@ { "type": "reflection", "declaration": { - "id": 590, + "id": 632, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 591, + "id": 633, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8575,9 +10177,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 61, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L57" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L61" } ], "type": { @@ -8587,7 +10189,7 @@ [ { "type": "reference", - "target": 638, + "target": 680, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", "package": "@supabase/realtime-js" }, @@ -8597,7 +10199,7 @@ } }, { - "id": 592, + "id": 634, "name": "new", "variant": "declaration", "kind": 1024, @@ -8605,15 +10207,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ], "type": { "type": "reflection", "declaration": { - "id": 593, + "id": 635, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8621,16 +10223,16 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ] } } }, { - "id": 594, + "id": 636, "name": "old", "variant": "declaration", "kind": 1024, @@ -8638,9 +10240,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 59, + "line": 63, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L59" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L63" } ], "type": { @@ -8652,7 +10254,7 @@ "typeArguments": [ { "type": "reference", - "target": 595, + "target": 637, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8666,15 +10268,15 @@ "groups": [ { "title": "Properties", - "children": [591, 592, 594] + "children": [633, 634, 636] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 56, + "line": 60, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L56" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L60" } ] } @@ -8683,7 +10285,7 @@ } }, { - "id": 570, + "id": 612, "name": "RealtimePostgresInsertPayload", "variant": "declaration", "kind": 2097152, @@ -8691,14 +10293,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "typeParameters": [ { - "id": 576, + "id": 618, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8706,7 +10308,7 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 619, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8714,14 +10316,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "indexSignatures": [ { - "id": 578, + "id": 620, "name": "__index", "variant": "signature", "kind": 8192, @@ -8729,14 +10331,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "parameters": [ { - "id": 579, + "id": 621, "name": "key", "variant": "param", "kind": 32768, @@ -8772,14 +10374,14 @@ { "type": "reflection", "declaration": { - "id": 571, + "id": 613, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 572, + "id": 614, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8787,9 +10389,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 43, + "line": 47, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L43" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L47" } ], "type": { @@ -8799,7 +10401,7 @@ [ { "type": "reference", - "target": 636, + "target": 678, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", "package": "@supabase/realtime-js" }, @@ -8809,7 +10411,7 @@ } }, { - "id": 573, + "id": 615, "name": "new", "variant": "declaration", "kind": 1024, @@ -8817,21 +10419,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 48, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L44" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L48" } ], "type": { "type": "reference", - "target": 576, + "target": 618, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 574, + "id": 616, "name": "old", "variant": "declaration", "kind": 1024, @@ -8839,15 +10441,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 617, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8855,9 +10457,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ] } @@ -8867,15 +10469,15 @@ "groups": [ { "title": "Properties", - "children": [572, 573, 574] + "children": [614, 615, 616] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 42, + "line": 46, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L42" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L46" } ] } @@ -8884,7 +10486,7 @@ } }, { - "id": 580, + "id": 622, "name": "RealtimePostgresUpdatePayload", "variant": "declaration", "kind": 2097152, @@ -8892,14 +10494,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "typeParameters": [ { - "id": 585, + "id": 627, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8907,7 +10509,7 @@ "type": { "type": "reflection", "declaration": { - "id": 586, + "id": 628, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8915,14 +10517,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "indexSignatures": [ { - "id": 587, + "id": 629, "name": "__index", "variant": "signature", "kind": 8192, @@ -8930,14 +10532,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "parameters": [ { - "id": 588, + "id": 630, "name": "key", "variant": "param", "kind": 32768, @@ -8973,14 +10575,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 623, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 582, + "id": 624, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8988,9 +10590,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 54, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L50" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L54" } ], "type": { @@ -9000,7 +10602,7 @@ [ { "type": "reference", - "target": 637, + "target": 679, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", "package": "@supabase/realtime-js" }, @@ -9010,7 +10612,7 @@ } }, { - "id": 583, + "id": 625, "name": "new", "variant": "declaration", "kind": 1024, @@ -9018,21 +10620,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 55, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L51" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L55" } ], "type": { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 584, + "id": 626, "name": "old", "variant": "declaration", "kind": 1024, @@ -9040,9 +10642,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 56, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L52" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L56" } ], "type": { @@ -9054,7 +10656,7 @@ "typeArguments": [ { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9068,15 +10670,15 @@ "groups": [ { "title": "Properties", - "children": [582, 583, 584] + "children": [624, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 49, + "line": 53, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L49" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L53" } ] } @@ -9085,7 +10687,7 @@ } }, { - "id": 599, + "id": 641, "name": "RealtimePresenceJoinPayload", "variant": "declaration", "kind": 2097152, @@ -9095,12 +10697,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "typeParameters": [ { - "id": 605, + "id": 647, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9108,7 +10710,7 @@ "type": { "type": "reflection", "declaration": { - "id": 606, + "id": 648, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9118,12 +10720,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 50, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "indexSignatures": [ { - "id": 607, + "id": 649, "name": "__index", "variant": "signature", "kind": 8192, @@ -9133,12 +10735,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "parameters": [ { - "id": 608, + "id": 650, "name": "key", "variant": "param", "kind": 32768, @@ -9162,14 +10764,14 @@ "type": { "type": "reflection", "declaration": { - "id": 600, + "id": 642, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 603, + "id": 645, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -9179,7 +10781,7 @@ "fileName": "src/RealtimePresence.ts", "line": 24, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L24" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L24" } ], "type": { @@ -9193,7 +10795,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9205,7 +10807,7 @@ } }, { - "id": 601, + "id": 643, "name": "event", "variant": "declaration", "kind": 1024, @@ -9215,7 +10817,7 @@ "fileName": "src/RealtimePresence.ts", "line": 22, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L22" } ], "type": { @@ -9225,7 +10827,7 @@ [ { "type": "reference", - "target": 641, + "target": 683, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", "package": "@supabase/realtime-js" }, @@ -9235,7 +10837,7 @@ } }, { - "id": 602, + "id": 644, "name": "key", "variant": "declaration", "kind": 1024, @@ -9245,7 +10847,7 @@ "fileName": "src/RealtimePresence.ts", "line": 23, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L23" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L23" } ], "type": { @@ -9254,7 +10856,7 @@ } }, { - "id": 604, + "id": 646, "name": "newPresences", "variant": "declaration", "kind": 1024, @@ -9264,7 +10866,7 @@ "fileName": "src/RealtimePresence.ts", "line": 25, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L25" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L25" } ], "type": { @@ -9278,7 +10880,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9293,7 +10895,7 @@ "groups": [ { "title": "Properties", - "children": [603, 601, 602, 604] + "children": [645, 643, 644, 646] } ], "sources": [ @@ -9301,14 +10903,14 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 76, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ] } } }, { - "id": 609, + "id": 651, "name": "RealtimePresenceLeavePayload", "variant": "declaration", "kind": 2097152, @@ -9318,12 +10920,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "typeParameters": [ { - "id": 615, + "id": 657, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9331,7 +10933,7 @@ "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 658, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9341,12 +10943,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 51, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "indexSignatures": [ { - "id": 617, + "id": 659, "name": "__index", "variant": "signature", "kind": 8192, @@ -9356,12 +10958,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "parameters": [ { - "id": 618, + "id": 660, "name": "key", "variant": "param", "kind": 32768, @@ -9385,14 +10987,14 @@ "type": { "type": "reflection", "declaration": { - "id": 610, + "id": 652, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 613, + "id": 655, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -9402,7 +11004,7 @@ "fileName": "src/RealtimePresence.ts", "line": 31, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L31" } ], "type": { @@ -9416,7 +11018,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9428,7 +11030,7 @@ } }, { - "id": 611, + "id": 653, "name": "event", "variant": "declaration", "kind": 1024, @@ -9438,7 +11040,7 @@ "fileName": "src/RealtimePresence.ts", "line": 29, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L29" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L29" } ], "type": { @@ -9448,7 +11050,7 @@ [ { "type": "reference", - "target": 642, + "target": 684, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", "package": "@supabase/realtime-js" }, @@ -9458,7 +11060,7 @@ } }, { - "id": 612, + "id": 654, "name": "key", "variant": "declaration", "kind": 1024, @@ -9468,7 +11070,7 @@ "fileName": "src/RealtimePresence.ts", "line": 30, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L30" } ], "type": { @@ -9477,7 +11079,7 @@ } }, { - "id": 614, + "id": 656, "name": "leftPresences", "variant": "declaration", "kind": 1024, @@ -9487,7 +11089,7 @@ "fileName": "src/RealtimePresence.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L32" } ], "type": { @@ -9501,7 +11103,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9516,7 +11118,7 @@ "groups": [ { "title": "Properties", - "children": [613, 611, 612, 614] + "children": [655, 653, 654, 656] } ], "sources": [ @@ -9524,14 +11126,14 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 77, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ] } } }, { - "id": 619, + "id": 661, "name": "RealtimePresenceState", "variant": "declaration", "kind": 2097152, @@ -9541,12 +11143,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "typeParameters": [ { - "id": 623, + "id": 665, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9554,7 +11156,7 @@ "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 666, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9564,12 +11166,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 625, + "id": 667, "name": "__index", "variant": "signature", "kind": 8192, @@ -9579,12 +11181,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 46, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "parameters": [ { - "id": 626, + "id": 668, "name": "key", "variant": "param", "kind": 32768, @@ -9606,7 +11208,7 @@ "default": { "type": "reflection", "declaration": { - "id": 627, + "id": 669, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9616,7 +11218,7 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ] } @@ -9626,7 +11228,7 @@ "type": { "type": "reflection", "declaration": { - "id": 620, + "id": 662, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9636,12 +11238,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 621, + "id": 663, "name": "__index", "variant": "signature", "kind": 8192, @@ -9651,12 +11253,12 @@ "fileName": "src/RealtimePresence.ts", "line": 18, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L18" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L18" } ], "parameters": [ { - "id": 622, + "id": 664, "name": "key", "variant": "param", "kind": 32768, @@ -9678,7 +11280,7 @@ "typeArguments": [ { "type": "reference", - "target": 623, + "target": 665, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9694,7 +11296,7 @@ } }, { - "id": 628, + "id": 670, "name": "RealtimeRemoveChannelResponse", "variant": "declaration", "kind": 2097152, @@ -9704,7 +11306,7 @@ "fileName": "src/RealtimeClient.ts", "line": 39, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L39" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L39" } ], "type": { @@ -9726,7 +11328,7 @@ } }, { - "id": 648, + "id": 690, "name": "REALTIME_CHANNEL_STATES", "variant": "declaration", "kind": 32, @@ -9736,9 +11338,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 111, + "line": 115, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L111" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L115" } ], "type": { @@ -9760,26 +11362,30 @@ "groups": [ { "title": "Enumerations", - "children": [629, 634, 639, 643] + "children": [671, 676, 681, 685] }, { "title": "Classes", - "children": [59, 369, 1] + "children": [59, 372, 1, 691] + }, + { + "title": "Interfaces", + "children": [708, 758] }, { "title": "Type Aliases", - "children": [355, 368, 526, 551, 558, 565, 589, 570, 580, 599, 609, 619, 628] + "children": [358, 371, 564, 593, 600, 607, 631, 612, 622, 641, 651, 661, 670] }, { "title": "Variables", - "children": [648] + "children": [690] } ], "packageName": "@supabase/realtime-js", "readme": [ { "kind": "text", - "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n
\n\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" }, { "kind": "code", @@ -9863,7 +11469,7 @@ }, { "kind": "code", - "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { config: { broadcast: { ack: false, self: false } } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" }, { "kind": "text", @@ -10799,909 +12405,1217 @@ "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "default.teardown" }, - "355": { + "358": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelOptions" }, - "356": { + "359": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "357": { + "360": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.config" }, - "358": { + "361": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "359": { + "362": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.broadcast" }, - "360": { + "363": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "361": { + "364": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.self" }, - "362": { + "365": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.ack" }, - "363": { + "366": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.presence" }, - "364": { + "367": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "365": { + "368": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.key" }, - "366": { + "369": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.enabled" }, - "367": { + "370": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.private" }, - "368": { + "371": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelSendResponse" }, - "369": { + "372": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "370": { + "373": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.__constructor" }, - "371": { + "374": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "372": { + "375": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "endPoint" }, - "373": { + "376": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "options" }, - "374": { + "377": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessTokenValue" }, - "375": { + "378": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.apiKey" }, - "376": { + "379": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channels" }, - "377": { + "380": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endPoint" }, - "378": { + "381": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.httpEndpoint" }, - "379": { + "382": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.headers" }, - "380": { + "383": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "381": { + "384": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "383": { + "386": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.params" }, - "384": { + "387": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "385": { + "388": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "387": { + "390": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.timeout" }, - "388": { + "391": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.transport" }, - "389": { + "392": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatIntervalMs" }, - "390": { + "393": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatTimer" }, - "391": { + "394": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.pendingHeartbeatRef" }, - "392": { + "395": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatCallback" }, - "393": { + "396": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "394": { + "397": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "395": { + "398": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "396": { + "399": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.ref" }, - "397": { + "400": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectTimer" }, - "398": { + "401": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logger" }, - "399": { + "402": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logLevel" }, - "400": { + "403": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.encode" }, - "401": { + "404": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.decode" }, - "402": { + "405": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectAfterMs" }, - "403": { + "406": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.conn" }, - "404": { + "407": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendBuffer" }, - "405": { + "408": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.serializer" }, - "406": { + "409": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.stateChangeCallbacks" }, - "407": { + "410": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "408": { + "411": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.open" }, - "409": { + "412": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.close" }, - "410": { + "413": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.error" }, - "411": { + "414": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.message" }, - "412": { + "415": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.fetch" }, - "413": { + "416": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "414": { + "417": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "415": { + "418": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, - "416": { + "419": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, - "417": { + "420": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, - "418": { + "421": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, - "419": { + "422": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, - "420": { + "423": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessToken" }, - "421": { + "424": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "422": { + "425": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "423": { + "426": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.worker" }, - "424": { + "427": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerUrl" }, - "425": { + "428": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerRef" }, - "426": { + "432": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "427": { + "433": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "428": { + "434": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "429": { + "435": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "430": { + "436": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "431": { + "437": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "432": { + "438": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "code" }, - "433": { + "439": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "reason" }, - "434": { + "440": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "435": { + "441": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "436": { + "442": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "437": { + "443": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "438": { + "444": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "channel" }, - "439": { + "445": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "440": { + "446": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "441": { + "447": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "442": { + "448": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "443": { + "449": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "kind" }, - "444": { + "450": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "msg" }, - "445": { + "451": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "446": { + "452": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "447": { + "453": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "448": { + "454": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "449": { + "455": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "450": { + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "460": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "451": { + "461": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "452": { + "462": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "topic" }, - "453": { + "463": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "params" }, - "454": { + "464": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "455": { + "465": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "456": { + "466": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "457": { + "467": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "458": { + "468": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "459": { + "469": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "token" }, - "460": { + "470": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "461": { + "471": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "462": { + "472": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "463": { + "473": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "464": { + "474": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "callback" }, - "465": { + "475": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "466": { + "476": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "467": { + "477": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "468": { + "478": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "469": { + "479": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "526": { + "564": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeClientOptions" }, - "527": { + "565": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "528": { + "566": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.transport" }, - "529": { + "567": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.timeout" }, - "530": { + "568": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.heartbeatIntervalMs" }, - "531": { + "569": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatCallback" + }, + "570": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "572": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "status" + }, + "573": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logger" }, - "532": { + "574": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.encode" }, - "533": { + "575": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.decode" }, - "534": { + "576": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.reconnectAfterMs" }, - "535": { + "577": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.headers" }, - "536": { + "578": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "537": { + "579": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "539": { + "581": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.params" }, - "540": { + "582": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "541": { + "583": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "543": { + "585": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.log_level" }, - "544": { + "586": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logLevel" }, - "545": { + "587": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.fetch" }, - "546": { + "588": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.worker" }, - "547": { + "589": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.workerUrl" }, - "548": { + "590": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.accessToken" }, - "549": { + "591": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "550": { + "592": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "551": { + "593": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeMessage" }, - "552": { + "594": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "553": { + "595": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.topic" }, - "554": { + "596": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.event" }, - "555": { + "597": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.payload" }, - "556": { + "598": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.ref" }, - "557": { + "599": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.join_ref" }, - "558": { + "600": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesFilter" }, - "559": { + "601": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "560": { + "602": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.event" }, - "561": { + "603": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.schema" }, - "562": { + "604": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.table" }, - "563": { + "605": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.filter" }, - "564": { + "606": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "565": { + "607": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesPayload" }, - "566": { + "608": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "567": { + "609": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "568": { + "610": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "570": { + "612": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresInsertPayload" }, - "571": { + "613": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "572": { + "614": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "573": { + "615": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "574": { + "616": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "575": { + "617": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "576": { + "618": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "577": { + "619": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "578": { + "620": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "580": { + "622": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresUpdatePayload" }, - "581": { + "623": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "582": { + "624": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "583": { + "625": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "584": { + "626": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "585": { + "627": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "586": { + "628": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "587": { + "629": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "589": { + "631": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresDeletePayload" }, - "590": { + "632": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "591": { + "633": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "592": { + "634": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "593": { + "635": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "594": { + "636": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "595": { + "637": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "596": { + "638": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "597": { + "639": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "599": { + "641": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceJoinPayload" }, - "600": { + "642": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "601": { + "643": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "602": { + "644": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "603": { + "645": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "604": { + "646": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.newPresences" }, - "605": { + "647": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "606": { + "648": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "607": { + "649": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "609": { + "651": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceLeavePayload" }, - "610": { + "652": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "611": { + "653": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "612": { + "654": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "613": { + "655": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "614": { + "656": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.leftPresences" }, - "615": { + "657": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "616": { + "658": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "617": { + "659": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "619": { + "661": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceState" }, - "620": { + "662": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "621": { + "663": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "623": { + "665": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "624": { + "666": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "625": { + "667": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "627": { + "669": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "628": { + "670": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeRemoveChannelResponse" }, - "629": { + "671": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES" }, - "630": { + "672": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" }, - "631": { + "673": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" }, - "632": { + "674": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" }, - "633": { + "675": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" }, - "634": { + "676": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, - "635": { + "677": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" }, - "636": { + "678": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, - "637": { + "679": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, - "638": { + "680": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, - "639": { + "681": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" }, - "640": { + "682": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" }, - "641": { + "683": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, - "642": { + "684": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, - "643": { + "685": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES" }, - "644": { + "686": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" }, - "645": { + "687": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" }, - "646": { + "688": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" }, - "647": { + "689": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" }, - "648": { + "690": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_CHANNEL_STATES" + }, + "691": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory" + }, + "694": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "695": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "696": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "697": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "698": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "url" + }, + "699": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "protocols" + }, + "700": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "701": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "702": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "url" + }, + "703": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "protocols" + }, + "704": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "705": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "708": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike" + }, + "709": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CONNECTING" + }, + "710": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.OPEN" + }, + "711": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSING" + }, + "712": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSED" + }, + "713": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.readyState" + }, + "714": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.url" + }, + "715": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.protocol" + }, + "716": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "717": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "718": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "code" + }, + "719": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "reason" + }, + "720": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "721": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "722": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "data" + }, + "723": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onopen" + }, + "724": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "725": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "726": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "727": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "728": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onmessage" + }, + "729": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "730": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "731": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "732": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "733": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onclose" + }, + "734": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "735": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "736": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "737": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "738": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onerror" + }, + "739": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "740": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "741": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "742": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "743": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "744": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "745": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "746": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "747": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "748": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "749": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "750": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "751": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.binaryType" + }, + "752": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.bufferedAmount" + }, + "753": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.extensions" + }, + "754": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.dispatchEvent" + }, + "755": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "756": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "757": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "event" + }, + "758": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "759": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "760": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "761": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "address" + }, + "762": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "subprotocols" + }, + "763": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor.__index" } }, "files": { diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json index e0b0f9f3436ea..c91c689d36a3a 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json @@ -6,14 +6,14 @@ "flags": {}, "children": [ { - "id": 629, + "id": 671, "name": "REALTIME_LISTEN_TYPES", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 630, + "id": 672, "name": "BROADCAST", "variant": "declaration", "kind": 16, @@ -21,9 +21,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 98, + "line": 102, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L102" } ], "type": { @@ -32,7 +32,7 @@ } }, { - "id": 632, + "id": 674, "name": "POSTGRES_CHANGES", "variant": "declaration", "kind": 16, @@ -40,9 +40,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 100, + "line": 104, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L100" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L104" } ], "type": { @@ -51,7 +51,7 @@ } }, { - "id": 631, + "id": 673, "name": "PRESENCE", "variant": "declaration", "kind": 16, @@ -59,9 +59,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 99, + "line": 103, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L99" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L103" } ], "type": { @@ -70,7 +70,7 @@ } }, { - "id": 633, + "id": 675, "name": "SYSTEM", "variant": "declaration", "kind": 16, @@ -78,9 +78,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 101, + "line": 105, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L101" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L105" } ], "type": { @@ -92,27 +92,27 @@ "groups": [ { "title": "Enumeration Members", - "children": [630, 632, 631, 633] + "children": [672, 674, 673, 675] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 97, + "line": 101, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L101" } ] }, { - "id": 634, + "id": 676, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 635, + "id": 677, "name": "ALL", "variant": "declaration", "kind": 16, @@ -120,9 +120,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 91, + "line": 95, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L91" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L95" } ], "type": { @@ -131,7 +131,7 @@ } }, { - "id": 638, + "id": 680, "name": "DELETE", "variant": "declaration", "kind": 16, @@ -139,9 +139,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 94, + "line": 98, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L94" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L98" } ], "type": { @@ -150,7 +150,7 @@ } }, { - "id": 636, + "id": 678, "name": "INSERT", "variant": "declaration", "kind": 16, @@ -158,9 +158,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 92, + "line": 96, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L92" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L96" } ], "type": { @@ -169,7 +169,7 @@ } }, { - "id": 637, + "id": 679, "name": "UPDATE", "variant": "declaration", "kind": 16, @@ -177,9 +177,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 93, + "line": 97, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L93" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L97" } ], "type": { @@ -191,27 +191,27 @@ "groups": [ { "title": "Enumeration Members", - "children": [635, 638, 636, 637] + "children": [677, 680, 678, 679] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 90, + "line": 94, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L90" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L94" } ] }, { - "id": 639, + "id": 681, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 641, + "id": 683, "name": "JOIN", "variant": "declaration", "kind": 16, @@ -221,7 +221,7 @@ "fileName": "src/RealtimePresence.ts", "line": 37, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L37" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L37" } ], "type": { @@ -230,7 +230,7 @@ } }, { - "id": 642, + "id": 684, "name": "LEAVE", "variant": "declaration", "kind": 16, @@ -240,7 +240,7 @@ "fileName": "src/RealtimePresence.ts", "line": 38, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L38" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L38" } ], "type": { @@ -249,7 +249,7 @@ } }, { - "id": 640, + "id": 682, "name": "SYNC", "variant": "declaration", "kind": 16, @@ -259,7 +259,7 @@ "fileName": "src/RealtimePresence.ts", "line": 36, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L36" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L36" } ], "type": { @@ -271,7 +271,7 @@ "groups": [ { "title": "Enumeration Members", - "children": [641, 642, 640] + "children": [683, 684, 682] } ], "sources": [ @@ -279,19 +279,19 @@ "fileName": "src/RealtimePresence.ts", "line": 35, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L35" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L35" } ] }, { - "id": 643, + "id": 685, "name": "REALTIME_SUBSCRIBE_STATES", "variant": "declaration", "kind": 8, "flags": {}, "children": [ { - "id": 647, + "id": 689, "name": "CHANNEL_ERROR", "variant": "declaration", "kind": 16, @@ -299,9 +299,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 108, + "line": 112, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L108" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L112" } ], "type": { @@ -310,7 +310,7 @@ } }, { - "id": 646, + "id": 688, "name": "CLOSED", "variant": "declaration", "kind": 16, @@ -318,9 +318,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 107, + "line": 111, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L107" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L111" } ], "type": { @@ -329,7 +329,7 @@ } }, { - "id": 644, + "id": 686, "name": "SUBSCRIBED", "variant": "declaration", "kind": 16, @@ -337,9 +337,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 105, + "line": 109, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L105" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L109" } ], "type": { @@ -348,7 +348,7 @@ } }, { - "id": 645, + "id": 687, "name": "TIMED_OUT", "variant": "declaration", "kind": 16, @@ -356,9 +356,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 106, + "line": 110, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L106" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L110" } ], "type": { @@ -370,15 +370,15 @@ "groups": [ { "title": "Enumeration Members", - "children": [647, 646, 644, 645] + "children": [689, 688, 686, 687] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 104, + "line": 108, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L108" } ] }, @@ -406,9 +406,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 147, + "line": 151, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" } ], "signatures": [ @@ -421,9 +421,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 147, + "line": 151, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L147" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L151" } ], "parameters": [ @@ -454,7 +454,7 @@ "flags": {}, "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -468,7 +468,7 @@ "flags": {}, "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -494,9 +494,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 132, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" } ], "type": { @@ -510,9 +510,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 132, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L132" } ], "indexSignatures": [ @@ -525,9 +525,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 133, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" } ], "parameters": [ @@ -563,9 +563,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 136, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L132" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L136" } ], "type": { @@ -587,9 +587,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "type": { @@ -603,9 +603,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "indexSignatures": [ @@ -618,9 +618,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 135, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L131" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L135" } ], "parameters": [ @@ -656,9 +656,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 133, + "line": 137, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L133" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L137" } ], "type": { @@ -675,9 +675,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 134, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L130" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L134" } ], "type": { @@ -695,9 +695,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 133, "character": 19, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L133" } ] } @@ -718,9 +718,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 143, + "line": 147, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L143" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L147" } ], "type": { @@ -737,9 +737,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 138, + "line": 142, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L138" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L142" } ], "type": { @@ -757,9 +757,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 139, + "line": 143, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L139" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L143" } ], "type": { @@ -784,14 +784,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 150, + "line": 154, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L154" } ], "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -806,9 +806,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 142, + "line": 146, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L142" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L146" } ], "type": { @@ -828,9 +828,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 145, + "line": 149, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L145" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L149" } ], "type": { @@ -847,9 +847,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 141, + "line": 145, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L141" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L145" } ], "type": { @@ -876,9 +876,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 140, + "line": 144, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L140" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L144" } ], "type": { @@ -903,14 +903,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 151, + "line": 155, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L151" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L155" } ], "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -925,9 +925,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 137, + "line": 141, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L137" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L141" } ], "type": { @@ -950,9 +950,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 144, + "line": 148, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L144" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L148" } ], "type": { @@ -969,9 +969,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 136, + "line": 140, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L136" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L140" } ], "type": { @@ -998,9 +998,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 149, + "line": 153, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L149" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L153" } ], "type": { @@ -1017,69 +1017,69 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 355, + "line": 370, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" }, { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" }, { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" }, { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" }, { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" }, { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" }, { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" }, { "fileName": "src/RealtimeChannel.ts", - "line": 396, + "line": 411, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" }, { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" }, { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" }, { "fileName": "src/RealtimeChannel.ts", - "line": 419, + "line": 434, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L419" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L434" } ], "signatures": [ @@ -1100,9 +1100,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 355, + "line": 370, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L355" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L370" } ], "parameters": [ @@ -1141,9 +1141,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 372, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" } ], "type": { @@ -1161,9 +1161,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 357, + "line": 372, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L357" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L372" } ] } @@ -1186,9 +1186,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 373, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" } ], "signatures": [ @@ -1201,9 +1201,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 358, + "line": 373, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L358" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L373" } ], "type": { @@ -1241,9 +1241,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "typeParameters": [ @@ -1264,9 +1264,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "indexSignatures": [ @@ -1279,9 +1279,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 360, + "line": 375, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L360" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L375" } ], "parameters": [ @@ -1343,9 +1343,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 362, + "line": 377, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" } ], "type": { @@ -1363,9 +1363,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 362, + "line": 377, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L362" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L377" } ] } @@ -1388,9 +1388,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 378, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" } ], "signatures": [ @@ -1403,9 +1403,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 363, + "line": 378, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L363" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L378" } ], "parameters": [ @@ -1417,7 +1417,7 @@ "flags": {}, "type": { "type": "reference", - "target": 599, + "target": 641, "typeArguments": [ { "type": "reference", @@ -1467,9 +1467,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "typeParameters": [ @@ -1490,9 +1490,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "indexSignatures": [ @@ -1505,9 +1505,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 365, + "line": 380, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L365" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L380" } ], "parameters": [ @@ -1569,9 +1569,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 367, + "line": 382, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" } ], "type": { @@ -1589,9 +1589,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 367, + "line": 382, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L367" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L382" } ] } @@ -1614,9 +1614,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, + "line": 383, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" } ], "signatures": [ @@ -1629,9 +1629,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 368, + "line": 383, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L368" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L383" } ], "parameters": [ @@ -1643,7 +1643,7 @@ "flags": {}, "type": { "type": "reference", - "target": 609, + "target": 651, "typeArguments": [ { "type": "reference", @@ -1693,9 +1693,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "typeParameters": [ @@ -1716,9 +1716,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "indexSignatures": [ @@ -1731,9 +1731,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 370, + "line": 385, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L370" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L385" } ], "parameters": [ @@ -1779,7 +1779,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -1807,9 +1807,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, + "line": 388, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" } ], "signatures": [ @@ -1822,9 +1822,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 373, + "line": 388, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L373" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L388" } ], "parameters": [ @@ -1836,7 +1836,7 @@ "flags": {}, "type": { "type": "reference", - "target": 565, + "target": 607, "typeArguments": [ { "type": "reference", @@ -1886,9 +1886,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "typeParameters": [ @@ -1909,9 +1909,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "indexSignatures": [ @@ -1924,9 +1924,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 375, + "line": 390, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L375" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L390" } ], "parameters": [ @@ -1972,7 +1972,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2000,9 +2000,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, + "line": 393, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" } ], "signatures": [ @@ -2015,9 +2015,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 378, + "line": 393, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L378" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L393" } ], "parameters": [ @@ -2029,7 +2029,7 @@ "flags": {}, "type": { "type": "reference", - "target": 570, + "target": 612, "typeArguments": [ { "type": "reference", @@ -2079,9 +2079,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "typeParameters": [ @@ -2102,9 +2102,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "indexSignatures": [ @@ -2117,9 +2117,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 380, + "line": 395, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L380" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L395" } ], "parameters": [ @@ -2165,7 +2165,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2193,9 +2193,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 383, + "line": 398, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" } ], "signatures": [ @@ -2208,9 +2208,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 383, + "line": 398, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L383" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L398" } ], "parameters": [ @@ -2222,7 +2222,7 @@ "flags": {}, "type": { "type": "reference", - "target": 580, + "target": 622, "typeArguments": [ { "type": "reference", @@ -2272,9 +2272,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "typeParameters": [ @@ -2295,9 +2295,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "indexSignatures": [ @@ -2310,9 +2310,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 385, + "line": 400, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L385" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L400" } ], "parameters": [ @@ -2358,7 +2358,7 @@ "flags": {}, "type": { "type": "reference", - "target": 558, + "target": 600, "typeArguments": [ { "type": "literal", @@ -2386,9 +2386,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 388, + "line": 403, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" } ], "signatures": [ @@ -2401,9 +2401,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 388, + "line": 403, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L388" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L403" } ], "parameters": [ @@ -2415,7 +2415,7 @@ "flags": {}, "type": { "type": "reference", - "target": 589, + "target": 631, "typeArguments": [ { "type": "reference", @@ -2465,9 +2465,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 396, + "line": 411, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L396" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L411" } ], "parameters": [ @@ -2522,9 +2522,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 398, + "line": 413, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" } ], "type": { @@ -2542,9 +2542,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 398, + "line": 413, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L398" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L413" } ] } @@ -2575,9 +2575,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "signatures": [ @@ -2590,9 +2590,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "parameters": [ @@ -2620,9 +2620,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 401, + "line": 416, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L401" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L416" } ], "type": { @@ -2639,9 +2639,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 400, + "line": 415, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L400" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L415" } ], "type": { @@ -2659,9 +2659,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 399, + "line": 414, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L399" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L414" } ], "indexSignatures": [ @@ -2674,9 +2674,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 402, + "line": 417, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L402" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L417" } ], "parameters": [ @@ -2737,9 +2737,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "typeParameters": [ @@ -2760,9 +2760,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "indexSignatures": [ @@ -2775,9 +2775,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 405, + "line": 420, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L405" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L420" } ], "parameters": [ @@ -2839,9 +2839,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 407, + "line": 422, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ], "type": { @@ -2859,9 +2859,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 407, + "line": 422, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L407" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L422" } ] } @@ -2884,9 +2884,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ], "signatures": [ @@ -2899,9 +2899,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ], "parameters": [ @@ -2929,9 +2929,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 410, + "line": 425, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L410" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L425" } ], "type": { @@ -2948,9 +2948,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 411, + "line": 426, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L411" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L426" } ], "type": { @@ -2970,9 +2970,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 409, + "line": 424, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L409" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L424" } ], "type": { @@ -2990,9 +2990,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 408, + "line": 423, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L408" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L423" } ] } @@ -3034,9 +3034,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "typeParameters": [ @@ -3057,9 +3057,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "indexSignatures": [ @@ -3072,9 +3072,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 414, + "line": 429, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L414" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L429" } ], "parameters": [ @@ -3146,9 +3146,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 417, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "signatures": [ @@ -3161,9 +3161,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 417, + "line": 432, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L417" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L432" } ], "parameters": [ @@ -3208,9 +3208,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 320, + "line": 335, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" } ], "signatures": [ @@ -3223,9 +3223,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 320, + "line": 335, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L320" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L335" } ], "typeParameters": [ @@ -3246,9 +3246,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 321, + "line": 336, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "indexSignatures": [ @@ -3261,9 +3261,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 321, + "line": 336, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L321" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L336" } ], "parameters": [ @@ -3301,7 +3301,7 @@ ], "type": { "type": "reference", - "target": 619, + "target": 661, "typeArguments": [ { "type": "reference", @@ -3326,9 +3326,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 445, + "line": 460, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" } ], "signatures": [ @@ -3349,9 +3349,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 445, + "line": 460, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L445" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L460" } ], "parameters": [ @@ -3395,9 +3395,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 448, + "line": 463, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L448" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L463" } ], "type": { @@ -3424,9 +3424,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 449, + "line": 464, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L449" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L464" } ], "type": { @@ -3451,9 +3451,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 447, + "line": 462, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L447" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L462" } ], "type": { @@ -3484,9 +3484,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 446, + "line": 461, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L446" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L461" } ], "indexSignatures": [ @@ -3499,9 +3499,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 450, + "line": 465, "character": 6, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L450" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L465" } ], "parameters": [ @@ -3551,9 +3551,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 452, + "line": 467, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" } ], "indexSignatures": [ @@ -3566,9 +3566,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 452, + "line": 467, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L452" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L467" } ], "parameters": [ @@ -3604,7 +3604,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -3624,9 +3624,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 213, + "line": 225, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" } ], "signatures": [ @@ -3647,9 +3647,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 213, + "line": 225, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L213" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L225" } ], "parameters": [ @@ -3672,9 +3672,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 214, + "line": 226, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "signatures": [ @@ -3687,9 +3687,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 214, + "line": 226, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L214" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L226" } ], "parameters": [ @@ -3701,7 +3701,7 @@ "flags": {}, "type": { "type": "reference", - "target": 643, + "target": 685, "name": "REALTIME_SUBSCRIBE_STATES", "package": "@supabase/realtime-js" } @@ -3766,9 +3766,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 561, + "line": 576, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" } ], "signatures": [ @@ -3789,9 +3789,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 561, + "line": 576, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L561" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L576" } ], "type": { @@ -3810,9 +3810,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 326, + "line": 341, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" } ], "signatures": [ @@ -3825,9 +3825,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 326, + "line": 341, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L326" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L341" } ], "parameters": [ @@ -3848,9 +3848,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 327, + "line": 342, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "indexSignatures": [ @@ -3863,9 +3863,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 327, + "line": 342, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L327" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L342" } ], "parameters": [ @@ -3907,9 +3907,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 328, + "line": 343, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], "indexSignatures": [ @@ -3922,9 +3922,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 328, + "line": 343, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L343" } ], "parameters": [ @@ -3960,7 +3960,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -3980,9 +3980,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 522, + "line": 537, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" } ], "signatures": [ @@ -4011,9 +4011,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 522, + "line": 537, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L522" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L537" } ], "parameters": [ @@ -4070,9 +4070,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 340, + "line": 355, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" } ], "signatures": [ @@ -4085,9 +4085,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 340, + "line": 355, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L340" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L355" } ], "parameters": [ @@ -4108,9 +4108,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 341, + "line": 356, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "indexSignatures": [ @@ -4123,9 +4123,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 341, + "line": 356, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L341" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L356" } ], "parameters": [ @@ -4161,7 +4161,7 @@ "typeArguments": [ { "type": "reference", - "target": 368, + "target": 371, "name": "RealtimeChannelSendResponse", "package": "@supabase/realtime-js" } @@ -4181,9 +4181,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "signatures": [ @@ -4196,9 +4196,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "parameters": [ @@ -4219,9 +4219,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 29, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "indexSignatures": [ @@ -4234,9 +4234,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 509, + "line": 524, "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L509" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L524" } ], "parameters": [ @@ -4287,21 +4287,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 131, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L131" } ] }, { - "id": 369, + "id": 372, "name": "RealtimeClient", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 370, + "id": 373, "name": "constructor", "variant": "declaration", "kind": 512, @@ -4309,14 +4309,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 171, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" } ], "signatures": [ { - "id": 371, + "id": 374, "name": "RealtimeClient", "variant": "signature", "kind": 16384, @@ -4332,14 +4332,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 150, + "line": 171, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L150" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L171" } ], "parameters": [ { - "id": 372, + "id": 375, "name": "endPoint", "variant": "param", "kind": 32768, @@ -4358,7 +4358,7 @@ } }, { - "id": 373, + "id": 376, "name": "options", "variant": "param", "kind": 32768, @@ -4367,7 +4367,7 @@ }, "type": { "type": "reference", - "target": 526, + "target": 564, "name": "RealtimeClientOptions", "package": "@supabase/realtime-js", "highlightedProperties": { @@ -4401,6 +4401,12 @@ "text": "The millisec interval to send a heartbeat message." } ], + "heartbeatCallback": [ + { + "kind": "text", + "text": "The optional function to handle heartbeat status." + } + ], "logger": [ { "kind": "text", @@ -4457,7 +4463,7 @@ ], "type": { "type": "reference", - "target": 369, + "target": 372, "name": "RealtimeClient", "package": "@supabase/realtime-js", "qualifiedName": "default" @@ -4466,7 +4472,7 @@ ] }, { - "id": 420, + "id": 423, "name": "accessToken", "variant": "declaration", "kind": 1024, @@ -4474,9 +4480,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "type": { @@ -4489,7 +4495,7 @@ { "type": "reflection", "declaration": { - "id": 421, + "id": 424, "name": "__type", "variant": "declaration", "kind": 65536, @@ -4497,14 +4503,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "signatures": [ { - "id": 422, + "id": 425, "name": "__type", "variant": "signature", "kind": 4096, @@ -4512,9 +4518,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 127, + "line": 144, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L127" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L144" } ], "type": { @@ -4550,7 +4556,7 @@ "defaultValue": "null" }, { - "id": 374, + "id": 377, "name": "accessTokenValue", "variant": "declaration", "kind": 1024, @@ -4558,9 +4564,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 91, + "line": 108, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L91" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L108" } ], "type": { @@ -4579,7 +4585,7 @@ "defaultValue": "null" }, { - "id": 375, + "id": 378, "name": "apiKey", "variant": "declaration", "kind": 1024, @@ -4587,9 +4593,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 92, + "line": 109, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L92" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L109" } ], "type": { @@ -4608,7 +4614,7 @@ "defaultValue": "null" }, { - "id": 376, + "id": 379, "name": "channels", "variant": "declaration", "kind": 1024, @@ -4616,9 +4622,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 93, + "line": 110, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L93" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L110" } ], "type": { @@ -4634,7 +4640,7 @@ "defaultValue": "..." }, { - "id": 403, + "id": 406, "name": "conn", "variant": "declaration", "kind": 1024, @@ -4642,9 +4648,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 129, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L112" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L129" } ], "type": { @@ -4656,19 +4662,16 @@ }, { "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" } ] }, "defaultValue": "null" }, { - "id": 401, + "id": 404, "name": "decode", "variant": "declaration", "kind": 1024, @@ -4676,9 +4679,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 110, + "line": 127, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L110" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L127" } ], "type": { @@ -4692,7 +4695,7 @@ } }, { - "id": 400, + "id": 403, "name": "encode", "variant": "declaration", "kind": 1024, @@ -4700,9 +4703,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 109, + "line": 126, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L109" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L126" } ], "type": { @@ -4716,7 +4719,7 @@ } }, { - "id": 377, + "id": 380, "name": "endPoint", "variant": "declaration", "kind": 1024, @@ -4724,9 +4727,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 94, + "line": 111, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L94" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L111" } ], "type": { @@ -4736,7 +4739,7 @@ "defaultValue": "''" }, { - "id": 412, + "id": 415, "name": "fetch", "variant": "declaration", "kind": 1024, @@ -4744,15 +4747,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 126, + "line": 143, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L126" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L143" } ], "type": { "type": "reflection", "declaration": { - "id": 413, + "id": 416, "name": "__type", "variant": "declaration", "kind": 65536, @@ -4771,7 +4774,7 @@ ], "signatures": [ { - "id": 414, + "id": 417, "name": "__type", "variant": "signature", "kind": 4096, @@ -4793,7 +4796,7 @@ ], "parameters": [ { - "id": 415, + "id": 418, "name": "input", "variant": "param", "kind": 32768, @@ -4823,7 +4826,7 @@ } }, { - "id": 416, + "id": 419, "name": "init", "variant": "param", "kind": 32768, @@ -4863,7 +4866,7 @@ } }, { - "id": 417, + "id": 420, "name": "__type", "variant": "signature", "kind": 4096, @@ -4885,7 +4888,7 @@ ], "parameters": [ { - "id": 418, + "id": 421, "name": "input", "variant": "param", "kind": 32768, @@ -4919,7 +4922,7 @@ } }, { - "id": 419, + "id": 422, "name": "init", "variant": "param", "kind": 32768, @@ -4963,7 +4966,7 @@ } }, { - "id": 379, + "id": 382, "name": "headers", "variant": "declaration", "kind": 1024, @@ -4987,15 +4990,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "type": { "type": "reflection", "declaration": { - "id": 380, + "id": 383, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5003,14 +5006,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "indexSignatures": [ { - "id": 381, + "id": 384, "name": "__index", "variant": "signature", "kind": 8192, @@ -5018,14 +5021,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 97, + "line": 114, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L97" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L114" } ], "parameters": [ { - "id": 382, + "id": 385, "name": "key", "variant": "param", "kind": 32768, @@ -5047,7 +5050,7 @@ "defaultValue": "{}" }, { - "id": 392, + "id": 395, "name": "heartbeatCallback", "variant": "declaration", "kind": 1024, @@ -5055,15 +5058,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 396, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5071,14 +5074,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "signatures": [ { - "id": 394, + "id": 397, "name": "__type", "variant": "signature", "kind": 4096, @@ -5086,14 +5089,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 104, + "line": 121, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L104" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L121" } ], "parameters": [ { - "id": 395, + "id": 398, "name": "status", "variant": "param", "kind": 32768, @@ -5120,7 +5123,7 @@ "defaultValue": "noop" }, { - "id": 389, + "id": 392, "name": "heartbeatIntervalMs", "variant": "declaration", "kind": 1024, @@ -5128,19 +5131,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 101, + "line": 118, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L101" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L118" } ], "type": { "type": "intrinsic", "name": "number" }, - "defaultValue": "25000" + "defaultValue": "CONNECTION_TIMEOUTS.HEARTBEAT_INTERVAL" }, { - "id": 390, + "id": 393, "name": "heartbeatTimer", "variant": "declaration", "kind": 1024, @@ -5148,9 +5151,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 102, + "line": 119, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L102" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L119" } ], "type": { @@ -5175,7 +5178,7 @@ "defaultValue": "undefined" }, { - "id": 378, + "id": 381, "name": "httpEndpoint", "variant": "declaration", "kind": 1024, @@ -5183,9 +5186,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 95, + "line": 112, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L95" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L112" } ], "type": { @@ -5195,7 +5198,7 @@ "defaultValue": "''" }, { - "id": 398, + "id": 401, "name": "logger", "variant": "declaration", "kind": 1024, @@ -5203,9 +5206,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 107, + "line": 124, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L107" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L124" } ], "type": { @@ -5220,7 +5223,7 @@ "defaultValue": "noop" }, { - "id": 399, + "id": 402, "name": "logLevel", "variant": "declaration", "kind": 1024, @@ -5230,9 +5233,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 108, + "line": 125, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L108" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L125" } ], "type": { @@ -5246,7 +5249,7 @@ } }, { - "id": 383, + "id": 386, "name": "params", "variant": "declaration", "kind": 1024, @@ -5256,15 +5259,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "type": { "type": "reflection", "declaration": { - "id": 384, + "id": 387, "name": "__type", "variant": "declaration", "kind": 65536, @@ -5272,14 +5275,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "indexSignatures": [ { - "id": 385, + "id": 388, "name": "__index", "variant": "signature", "kind": 8192, @@ -5287,14 +5290,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 98, + "line": 115, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L98" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L115" } ], "parameters": [ { - "id": 386, + "id": 389, "name": "key", "variant": "param", "kind": 32768, @@ -5316,7 +5319,7 @@ "defaultValue": "{}" }, { - "id": 391, + "id": 394, "name": "pendingHeartbeatRef", "variant": "declaration", "kind": 1024, @@ -5324,9 +5327,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 103, + "line": 120, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L103" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L120" } ], "type": { @@ -5345,7 +5348,7 @@ "defaultValue": "null" }, { - "id": 402, + "id": 405, "name": "reconnectAfterMs", "variant": "declaration", "kind": 1024, @@ -5353,9 +5356,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 111, + "line": 128, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L111" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L128" } ], "type": { @@ -5369,7 +5372,7 @@ } }, { - "id": 397, + "id": 400, "name": "reconnectTimer", "variant": "declaration", "kind": 1024, @@ -5377,24 +5380,34 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 106, + "line": 123, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L106" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L123" } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/timer.ts", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "src/lib/timer.ts", + "qualifiedName": "default" + }, + "name": "Timer", + "package": "@supabase/realtime-js", + "qualifiedName": "default" + } + ] + }, + "defaultValue": "null" }, { - "id": 396, + "id": 399, "name": "ref", "variant": "declaration", "kind": 1024, @@ -5402,9 +5415,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 105, + "line": 122, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L105" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L122" } ], "type": { @@ -5414,7 +5427,7 @@ "defaultValue": "0" }, { - "id": 404, + "id": 407, "name": "sendBuffer", "variant": "declaration", "kind": 1024, @@ -5422,9 +5435,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 113, + "line": 130, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L113" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L130" } ], "type": { @@ -5442,7 +5455,7 @@ "defaultValue": "[]" }, { - "id": 405, + "id": 408, "name": "serializer", "variant": "declaration", "kind": 1024, @@ -5450,9 +5463,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 114, + "line": 131, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L114" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L131" } ], "type": { @@ -5468,7 +5481,7 @@ "defaultValue": "..." }, { - "id": 406, + "id": 409, "name": "stateChangeCallbacks", "variant": "declaration", "kind": 1024, @@ -5476,22 +5489,22 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, + "line": 132, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" } ], "type": { "type": "reflection", "declaration": { - "id": 407, + "id": 410, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 409, + "id": 412, "name": "close", "variant": "declaration", "kind": 1024, @@ -5499,9 +5512,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 117, + "line": 134, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L117" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L134" } ], "type": { @@ -5518,7 +5531,7 @@ } }, { - "id": 410, + "id": 413, "name": "error", "variant": "declaration", "kind": 1024, @@ -5526,9 +5539,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 118, + "line": 135, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L118" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L135" } ], "type": { @@ -5545,7 +5558,7 @@ } }, { - "id": 411, + "id": 414, "name": "message", "variant": "declaration", "kind": 1024, @@ -5553,9 +5566,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 119, + "line": 136, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L119" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L136" } ], "type": { @@ -5572,7 +5585,7 @@ } }, { - "id": 408, + "id": 411, "name": "open", "variant": "declaration", "kind": 1024, @@ -5580,9 +5593,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 116, + "line": 133, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L116" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L133" } ], "type": { @@ -5602,15 +5615,15 @@ "groups": [ { "title": "Properties", - "children": [409, 410, 411, 408] + "children": [412, 413, 414, 411] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 115, + "line": 132, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L115" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L132" } ] } @@ -5618,7 +5631,7 @@ "defaultValue": "..." }, { - "id": 387, + "id": 390, "name": "timeout", "variant": "declaration", "kind": 1024, @@ -5626,9 +5639,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 99, + "line": 116, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L99" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L116" } ], "type": { @@ -5638,7 +5651,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 388, + "id": 391, "name": "transport", "variant": "declaration", "kind": 1024, @@ -5646,9 +5659,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 100, + "line": 117, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L100" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L117" } ], "type": { @@ -5660,18 +5673,16 @@ }, { "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, + "target": 758, "name": "WebSocketLikeConstructor", "package": "@supabase/realtime-js" } ] - } + }, + "defaultValue": "null" }, { - "id": 423, + "id": 426, "name": "worker", "variant": "declaration", "kind": 1024, @@ -5681,9 +5692,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 128, + "line": 145, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L128" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L145" } ], "type": { @@ -5692,7 +5703,7 @@ } }, { - "id": 425, + "id": 428, "name": "workerRef", "variant": "declaration", "kind": 1024, @@ -5702,9 +5713,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 130, + "line": 147, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L130" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L147" } ], "type": { @@ -5718,7 +5729,7 @@ } }, { - "id": 424, + "id": 427, "name": "workerUrl", "variant": "declaration", "kind": 1024, @@ -5728,9 +5739,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 129, + "line": 146, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L129" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L146" } ], "type": { @@ -5739,7 +5750,7 @@ } }, { - "id": 450, + "id": 460, "name": "channel", "variant": "declaration", "kind": 2048, @@ -5747,14 +5758,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 328, + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], "signatures": [ { - "id": 451, + "id": 461, "name": "channel", "variant": "signature", "kind": 4096, @@ -5762,14 +5773,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 328, + "line": 365, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L328" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L365" } ], "parameters": [ { - "id": 452, + "id": 462, "name": "topic", "variant": "param", "kind": 32768, @@ -5780,14 +5791,14 @@ } }, { - "id": 453, + "id": 463, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 355, + "target": 358, "name": "RealtimeChannelOptions", "package": "@supabase/realtime-js" }, @@ -5805,7 +5816,7 @@ ] }, { - "id": 426, + "id": 432, "name": "connect", "variant": "declaration", "kind": 2048, @@ -5813,14 +5824,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 207, + "line": 190, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], "signatures": [ { - "id": 427, + "id": 433, "name": "connect", "variant": "signature", "kind": 4096, @@ -5836,9 +5847,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 207, + "line": 190, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L207" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L190" } ], "type": { @@ -5849,7 +5860,7 @@ ] }, { - "id": 446, + "id": 452, "name": "connectionState", "variant": "declaration", "kind": 2048, @@ -5857,14 +5868,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, + "line": 331, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" } ], "signatures": [ { - "id": 447, + "id": 453, "name": "connectionState", "variant": "signature", "kind": 4096, @@ -5880,9 +5891,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, + "line": 331, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L308" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L331" } ], "type": { @@ -5898,7 +5909,7 @@ ] }, { - "id": 430, + "id": 436, "name": "disconnect", "variant": "declaration", "kind": 2048, @@ -5906,14 +5917,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 244, + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "signatures": [ { - "id": 431, + "id": 437, "name": "disconnect", "variant": "signature", "kind": 4096, @@ -5929,14 +5940,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 244, + "line": 253, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L244" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L253" } ], "parameters": [ { - "id": 432, + "id": 438, "name": "code", "variant": "param", "kind": 32768, @@ -5957,7 +5968,7 @@ } }, { - "id": 433, + "id": 439, "name": "reason", "variant": "param", "kind": 32768, @@ -5986,7 +5997,7 @@ ] }, { - "id": 428, + "id": 434, "name": "endpointURL", "variant": "declaration", "kind": 2048, @@ -5994,14 +6005,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 231, + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "signatures": [ { - "id": 429, + "id": 435, "name": "endpointURL", "variant": "signature", "kind": 4096, @@ -6028,9 +6039,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 231, + "line": 240, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L231" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L240" } ], "type": { @@ -6041,7 +6052,7 @@ ] }, { - "id": 468, + "id": 478, "name": "flushSendBuffer", "variant": "declaration", "kind": 2048, @@ -6049,14 +6060,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 435, + "line": 482, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], "signatures": [ { - "id": 469, + "id": 479, "name": "flushSendBuffer", "variant": "signature", "kind": 4096, @@ -6072,9 +6083,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 435, + "line": 482, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L435" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L482" } ], "type": { @@ -6085,7 +6096,7 @@ ] }, { - "id": 434, + "id": 440, "name": "getChannels", "variant": "declaration", "kind": 2048, @@ -6093,14 +6104,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 264, + "line": 287, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" } ], "signatures": [ { - "id": 435, + "id": 441, "name": "getChannels", "variant": "signature", "kind": 4096, @@ -6116,9 +6127,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 264, + "line": 287, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L264" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L287" } ], "type": { @@ -6135,7 +6146,7 @@ ] }, { - "id": 448, + "id": 454, "name": "isConnected", "variant": "declaration", "kind": 2048, @@ -6143,14 +6154,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 324, + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "signatures": [ { - "id": 449, + "id": 455, "name": "isConnected", "variant": "signature", "kind": 4096, @@ -6174,9 +6185,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 324, + "line": 347, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L324" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L347" } ], "type": { @@ -6187,23 +6198,23 @@ ] }, { - "id": 441, - "name": "log", + "id": 456, + "name": "isConnecting", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 301, + "line": 354, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], "signatures": [ { - "id": 442, - "name": "log", + "id": 457, + "name": "isConnecting", "variant": "signature", "kind": 4096, "flags": {}, @@ -6211,40 +6222,144 @@ "summary": [ { "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " + "text": "Returns " }, { "kind": "code", - "text": "`this.logger`" + "text": "`true`" }, { "kind": "text", - "text": " can be overridden." + "text": " if the connection is currently connecting." } ] }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 301, + "line": 354, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L301" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L354" } ], - "parameters": [ - { - "id": 443, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 458, + "name": "isDisconnecting", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 361, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" + } + ], + "signatures": [ + { + "id": 459, + "name": "isDisconnecting", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": " if the connection is currently disconnecting." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 361, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L361" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 447, + "name": "log", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 324, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" + } + ], + "signatures": [ + { + "id": 448, + "name": "log", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logs the message.\n\nFor customized logging, " + }, + { + "kind": "code", + "text": "`this.logger`" + }, + { + "kind": "text", + "text": " can be overridden." + } + ] + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 324, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L324" + } + ], + "parameters": [ + { + "id": 449, + "name": "kind", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", "name": "string" } }, { - "id": 444, + "id": 450, "name": "msg", "variant": "param", "kind": 32768, @@ -6255,7 +6370,7 @@ } }, { - "id": 445, + "id": 451, "name": "data", "variant": "param", "kind": 32768, @@ -6276,7 +6391,7 @@ ] }, { - "id": 462, + "id": 472, "name": "onHeartbeat", "variant": "declaration", "kind": 2048, @@ -6284,14 +6399,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "signatures": [ { - "id": 463, + "id": 473, "name": "onHeartbeat", "variant": "signature", "kind": 4096, @@ -6299,14 +6414,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "parameters": [ { - "id": 464, + "id": 474, "name": "callback", "variant": "param", "kind": 32768, @@ -6314,7 +6429,7 @@ "type": { "type": "reflection", "declaration": { - "id": 465, + "id": 475, "name": "__type", "variant": "declaration", "kind": 65536, @@ -6322,14 +6437,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "signatures": [ { - "id": 466, + "id": 476, "name": "__type", "variant": "signature", "kind": 4096, @@ -6337,14 +6452,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 429, + "line": 476, "character": 24, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L429" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L476" } ], "parameters": [ { - "id": 467, + "id": 477, "name": "status", "variant": "param", "kind": 32768, @@ -6378,7 +6493,7 @@ ] }, { - "id": 454, + "id": 464, "name": "push", "variant": "declaration", "kind": 2048, @@ -6386,14 +6501,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 352, + "line": 389, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" } ], "signatures": [ { - "id": 455, + "id": 465, "name": "push", "variant": "signature", "kind": 4096, @@ -6409,21 +6524,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 352, + "line": 389, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L352" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L389" } ], "parameters": [ { - "id": 456, + "id": 466, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 551, + "target": 593, "name": "RealtimeMessage", "package": "@supabase/realtime-js" } @@ -6437,7 +6552,7 @@ ] }, { - "id": 439, + "id": 445, "name": "removeAllChannels", "variant": "declaration", "kind": 2048, @@ -6445,14 +6560,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 287, + "line": 310, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" } ], "signatures": [ { - "id": 440, + "id": 446, "name": "removeAllChannels", "variant": "signature", "kind": 4096, @@ -6468,9 +6583,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 287, + "line": 310, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L287" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L310" } ], "type": { @@ -6484,7 +6599,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 628, + "target": 670, "name": "RealtimeRemoveChannelResponse", "package": "@supabase/realtime-js" } @@ -6497,7 +6612,7 @@ ] }, { - "id": 436, + "id": 442, "name": "removeChannel", "variant": "declaration", "kind": 2048, @@ -6505,14 +6620,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 272, + "line": 295, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], "signatures": [ { - "id": 437, + "id": 443, "name": "removeChannel", "variant": "signature", "kind": 4096, @@ -6528,14 +6643,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 272, + "line": 295, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L272" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L295" } ], "parameters": [ { - "id": 438, + "id": 444, "name": "channel", "variant": "param", "kind": 32768, @@ -6566,7 +6681,7 @@ "typeArguments": [ { "type": "reference", - "target": 628, + "target": 670, "name": "RealtimeRemoveChannelResponse", "package": "@supabase/realtime-js" } @@ -6578,7 +6693,7 @@ ] }, { - "id": 460, + "id": 470, "name": "sendHeartbeat", "variant": "declaration", "kind": 2048, @@ -6586,14 +6701,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 403, + "line": 424, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], "signatures": [ { - "id": 461, + "id": 471, "name": "sendHeartbeat", "variant": "signature", "kind": 4096, @@ -6609,9 +6724,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 403, + "line": 424, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L403" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L424" } ], "type": { @@ -6633,7 +6748,7 @@ ] }, { - "id": 457, + "id": 467, "name": "setAuth", "variant": "declaration", "kind": 2048, @@ -6641,14 +6756,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 376, + "line": 413, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], "signatures": [ { - "id": 458, + "id": 468, "name": "setAuth", "variant": "signature", "kind": 4096, @@ -6672,14 +6787,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 376, + "line": 413, "character": 8, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L376" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L413" } ], "parameters": [ { - "id": 459, + "id": 469, "name": "token", "variant": "param", "kind": 32768, @@ -6730,26 +6845,28 @@ "groups": [ { "title": "Constructors", - "children": [370] + "children": [373] }, { "title": "Properties", "children": [ - 420, 374, 375, 376, 403, 401, 400, 377, 412, 379, 392, 389, 390, 378, 398, 399, 383, - 391, 402, 397, 396, 404, 405, 406, 387, 388, 423, 425, 424 + 423, 377, 378, 379, 406, 404, 403, 380, 415, 382, 395, 392, 393, 381, 401, 402, 386, + 394, 405, 400, 399, 407, 408, 409, 390, 391, 426, 428, 427 ] }, { "title": "Methods", - "children": [450, 426, 446, 430, 428, 468, 434, 448, 441, 462, 454, 439, 436, 460, 457] + "children": [ + 460, 432, 452, 436, 434, 478, 440, 454, 456, 458, 447, 472, 464, 445, 442, 470, 467 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 90, + "line": 107, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L90" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L107" } ] }, @@ -6771,7 +6888,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "signatures": [ @@ -6794,7 +6911,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "parameters": [ @@ -6872,7 +6989,7 @@ "fileName": "src/RealtimePresence.ts", "line": 68, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" } ], "type": { @@ -6895,7 +7012,7 @@ "fileName": "src/RealtimePresence.ts", "line": 69, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L69" } ], "type": { @@ -6919,7 +7036,7 @@ "fileName": "src/RealtimePresence.ts", "line": 70, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L70" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L70" } ], "type": { @@ -6943,7 +7060,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "type": { @@ -6959,7 +7076,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "signatures": [ @@ -6974,7 +7091,7 @@ "fileName": "src/RealtimePresence.ts", "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L71" } ], "type": { @@ -6998,7 +7115,7 @@ "fileName": "src/RealtimePresence.ts", "line": 68, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L68" } ] } @@ -7026,7 +7143,7 @@ "fileName": "src/RealtimePresence.ts", "line": 85, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L85" } ], "type": { @@ -7048,7 +7165,7 @@ "fileName": "src/RealtimePresence.ts", "line": 67, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L67" } ], "type": { @@ -7068,7 +7185,7 @@ "fileName": "src/RealtimePresence.ts", "line": 66, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L66" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L66" } ], "type": { @@ -7097,7 +7214,7 @@ "fileName": "src/RealtimePresence.ts", "line": 65, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L65" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L65" } ], "type": { @@ -7125,12 +7242,12 @@ "fileName": "src/RealtimePresence.ts", "line": 64, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L64" } ], "type": { "type": "reference", - "target": 619, + "target": 661, "name": "RealtimePresenceState", "package": "@supabase/realtime-js" }, @@ -7152,91 +7269,1513 @@ "fileName": "src/RealtimePresence.ts", "line": 63, "character": 21, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L63" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L63" } ] }, { - "id": 355, - "name": "RealtimeChannelOptions", + "id": 691, + "name": "WebSocketFactory", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 356, - "name": "__type", + "id": 706, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 357, - "name": "config", - "variant": "declaration", - "kind": 1024, + "id": 707, + "name": "WebSocketFactory", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 691, + "name": "WebSocketFactory", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 700, + "name": "createWebSocket", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" + } + ], + "signatures": [ + { + "id": 701, + "name": "createWebSocket", + "variant": "signature", + "kind": 4096, "flags": {}, "sources": [ { - "fileName": "src/RealtimeChannel.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "fileName": "src/lib/websocket-factory.ts", + "line": 141, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L141" + } + ], + "parameters": [ + { + "id": 702, + "name": "url", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 703, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + } + ] + }, + { + "id": 694, + "name": "getWebSocketConstructor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" + } + ], + "signatures": [ + { + "id": 695, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 128, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L128" } ], "type": { "type": "reflection", "declaration": { - "id": 358, + "id": 696, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, - "children": [ + "sources": [ { - "id": 359, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - } - ] - }, + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26772, + "character": 23 + } + ], + "signatures": [ + { + "id": 697, + "name": "getWebSocketConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 26774, + "character": 4 + } + ], + "parameters": [ + { + "id": 698, + "name": "url", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 699, + "name": "protocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "WebSocket" + }, + "name": "WebSocket", + "package": "typescript" + } + } + ] + } + } + } + ] + }, + { + "id": 704, + "name": "isWebSocketSupported", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isStatic": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" + } + ], + "signatures": [ + { + "id": 705, + "name": "isWebSocketSupported", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 149, + "character": 16, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L149" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [706] + }, + { + "title": "Methods", + "children": [700, 694, 704] + } + ], + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 35, + "character": 13, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L35" + } + ] + }, + { + "id": 708, + "name": "WebSocketLike", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 751, + "name": "binaryType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 22, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L22" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 752, + "name": "bufferedAmount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 23, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L23" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 712, + "name": "CLOSED", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 5, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L5" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 711, + "name": "CLOSING", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 4, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L4" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 709, + "name": "CONNECTING", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 2, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L2" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 754, + "name": "dispatchEvent", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 755, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "signatures": [ + { + "id": 756, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 25, + "character": 18, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L25" + } + ], + "parameters": [ + { + "id": 757, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + } + } + }, + { + "id": 753, + "name": "extensions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 24, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L24" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 733, + "name": "onclose", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 734, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "signatures": [ + { + "id": 735, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 15, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L15" + } + ], + "parameters": [ + { + "id": 736, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 737, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "CloseEvent" + }, + "name": "CloseEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 738, + "name": "onerror", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 739, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "signatures": [ + { + "id": 740, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 16, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L16" + } + ], + "parameters": [ + { + "id": 741, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 742, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 728, + "name": "onmessage", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 729, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "signatures": [ + { + "id": 730, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 14, + "character": 14, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L14" + } + ], + "parameters": [ + { + "id": 731, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 732, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "MessageEvent" + }, + "name": "MessageEvent", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 723, + "name": "onopen", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 724, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "signatures": [ + { + "id": 725, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 13, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L13" + } + ], + "parameters": [ + { + "id": 726, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 727, + "name": "ev", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Event" + }, + "name": "Event", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + ] + } + }, + { + "id": 710, + "name": "OPEN", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 3, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L3" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 715, + "name": "protocol", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 8, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L8" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 713, + "name": "readyState", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 6, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L6" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 714, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isReadonly": true + }, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 7, + "character": 11, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L7" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 743, + "name": "addEventListener", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" + } + ], + "signatures": [ + { + "id": 744, + "name": "addEventListener", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 18, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L18" + } + ], + "parameters": [ + { + "id": 745, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 746, + "name": "listener", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 716, + "name": "close", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 10, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" + } + ], + "signatures": [ + { + "id": 717, + "name": "close", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 10, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L10" + } + ], + "parameters": [ + { + "id": 718, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 719, + "name": "reason", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 747, + "name": "removeEventListener", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" + } + ], + "signatures": [ + { + "id": 748, + "name": "removeEventListener", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 19, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L19" + } + ], + "parameters": [ + { + "id": 749, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 750, + "name": "listener", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "EventListener" + }, + "name": "EventListener", + "package": "typescript" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 720, + "name": "send", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" + } + ], + "signatures": [ + { + "id": 721, + "name": "send", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 11, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L11" + } + ], + "parameters": [ + { + "id": 722, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferView" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBufferLike" + }, + "name": "ArrayBufferLike", + "package": "typescript" + } + ], + "name": "ArrayBufferView", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Blob" + }, + "name": "Blob", + "package": "typescript" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [751, 752, 712, 711, 709, 754, 753, 733, 738, 728, 723, 710, 715, 713, 714] + }, + { + "title": "Methods", + "children": [743, 716, 747, 720] + } + ], + "sources": [ + { + "fileName": "src/lib/websocket-factory.ts", + "line": 1, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/lib/websocket-factory.ts#L1" + } + ] + }, + { + "id": 758, + "name": "WebSocketLikeConstructor", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 759, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" + } + ], + "signatures": [ + { + "id": 760, + "name": "WebSocketLikeConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 66, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L66" + } + ], + "parameters": [ + { + "id": 761, + "name": "address", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "URL" + }, + "name": "URL", + "package": "typescript" + } + ] + } + }, + { + "id": 762, + "name": "subprotocols", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "target": 708, + "name": "WebSocketLike", + "package": "@supabase/realtime-js" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [759] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 65, + "character": 17, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L65" + } + ], + "indexSignatures": [ + { + "id": 763, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 71, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L71" + } + ], + "parameters": [ + { + "id": 764, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + }, + { + "id": 358, + "name": "RealtimeChannelOptions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 20, + "character": 12, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 360, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 21, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 361, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 362, + "name": "broadcast", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + } + ] + }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { "type": "reflection", "declaration": { - "id": 360, + "id": 363, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 362, + "id": 365, "name": "ack", "variant": "declaration", "kind": 1024, @@ -7246,9 +8785,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 34, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -7257,7 +8796,7 @@ } }, { - "id": 361, + "id": 364, "name": "self", "variant": "declaration", "kind": 1024, @@ -7267,9 +8806,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 18, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ], "type": { @@ -7281,22 +8820,22 @@ "groups": [ { "title": "Properties", - "children": [362, 361] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 22, + "line": 26, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L26" } ] } } }, { - "id": 363, + "id": 366, "name": "presence", "variant": "declaration", "kind": 1024, @@ -7314,22 +8853,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { "type": "reflection", "declaration": { - "id": 364, + "id": 367, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 366, + "id": 369, "name": "enabled", "variant": "declaration", "kind": 1024, @@ -7339,9 +8878,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 31, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -7350,7 +8889,7 @@ } }, { - "id": 365, + "id": 368, "name": "key", "variant": "declaration", "kind": 1024, @@ -7360,9 +8899,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 17, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ], "type": { @@ -7374,22 +8913,22 @@ "groups": [ { "title": "Properties", - "children": [366, 365] + "children": [369, 368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 26, + "line": 30, "character": 15, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L26" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L30" } ] } } }, { - "id": 367, + "id": 370, "name": "private", "variant": "declaration", "kind": 1024, @@ -7407,9 +8946,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 30, + "line": 34, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L34" } ], "type": { @@ -7421,15 +8960,15 @@ "groups": [ { "title": "Properties", - "children": [359, 363, 367] + "children": [362, 366, 370] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 17, + "line": 21, "character": 10, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L21" } ] } @@ -7439,22 +8978,22 @@ "groups": [ { "title": "Properties", - "children": [357] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 20, "character": 37, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L16" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L20" } ] } } }, { - "id": 368, + "id": 371, "name": "RealtimeChannelSendResponse", "variant": "declaration", "kind": 2097152, @@ -7462,9 +9001,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 92, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L88" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L92" } ], "type": { @@ -7486,7 +9025,7 @@ } }, { - "id": 526, + "id": 564, "name": "RealtimeClientOptions", "variant": "declaration", "kind": 2097152, @@ -7494,22 +9033,22 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 527, + "id": 565, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 548, + "id": 590, "name": "accessToken", "variant": "declaration", "kind": 1024, @@ -7519,15 +9058,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "type": { "type": "reflection", "declaration": { - "id": 549, + "id": 591, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7535,14 +9074,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 97, "character": 16, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L80" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L97" } ], "signatures": [ { - "id": 550, + "id": 592, "name": "__type", "variant": "signature", "kind": 4096, @@ -7577,7 +9116,7 @@ } }, { - "id": 533, + "id": 575, "name": "decode", "variant": "declaration", "kind": 1024, @@ -7587,9 +9126,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 87, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L70" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L87" } ], "type": { @@ -7603,7 +9142,7 @@ } }, { - "id": 532, + "id": 574, "name": "encode", "variant": "declaration", "kind": 1024, @@ -7613,9 +9152,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 86, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L86" } ], "type": { @@ -7629,7 +9168,7 @@ } }, { - "id": 545, + "id": 587, "name": "fetch", "variant": "declaration", "kind": 1024, @@ -7639,9 +9178,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 94, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L94" } ], "type": { @@ -7655,7 +9194,7 @@ } }, { - "id": 535, + "id": 577, "name": "headers", "variant": "declaration", "kind": 1024, @@ -7665,15 +9204,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "type": { "type": "reflection", "declaration": { - "id": 536, + "id": 578, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7681,14 +9220,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "indexSignatures": [ { - "id": 537, + "id": 579, "name": "__index", "variant": "signature", "kind": 8192, @@ -7696,14 +9235,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 89, "character": 14, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L72" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L89" } ], "parameters": [ { - "id": 538, + "id": 580, "name": "key", "variant": "param", "kind": 32768, @@ -7724,7 +9263,73 @@ } }, { - "id": 530, + "id": 569, + "name": "heartbeatCallback", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 2, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 84, + "character": 22, + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L84" + } + ], + "signatures": [ + { + "id": 571, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "status", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "HeartbeatStatus" + }, + "name": "HeartbeatStatus", + "package": "@supabase/realtime-js" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 568, "name": "heartbeatIntervalMs", "variant": "declaration", "kind": 1024, @@ -7734,9 +9339,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 83, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L83" } ], "type": { @@ -7745,7 +9350,7 @@ } }, { - "id": 543, + "id": 585, "name": "log_level", "variant": "declaration", "kind": 1024, @@ -7755,9 +9360,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 92, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L75" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L92" } ], "type": { @@ -7771,7 +9376,7 @@ } }, { - "id": 531, + "id": 573, "name": "logger", "variant": "declaration", "kind": 1024, @@ -7781,9 +9386,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L68" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L85" } ], "type": { @@ -7797,7 +9402,7 @@ } }, { - "id": 544, + "id": 586, "name": "logLevel", "variant": "declaration", "kind": 1024, @@ -7807,9 +9412,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 93, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L76" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L93" } ], "type": { @@ -7823,7 +9428,7 @@ } }, { - "id": 539, + "id": 581, "name": "params", "variant": "declaration", "kind": 1024, @@ -7833,15 +9438,15 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "type": { "type": "reflection", "declaration": { - "id": 540, + "id": 582, "name": "__type", "variant": "declaration", "kind": 65536, @@ -7849,14 +9454,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 11, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "indexSignatures": [ { - "id": 541, + "id": 583, "name": "__index", "variant": "signature", "kind": 8192, @@ -7864,14 +9469,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 90, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L90" } ], "parameters": [ { - "id": 542, + "id": 584, "name": "key", "variant": "param", "kind": 32768, @@ -7892,7 +9497,7 @@ } }, { - "id": 534, + "id": 576, "name": "reconnectAfterMs", "variant": "declaration", "kind": 1024, @@ -7902,9 +9507,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 88, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L71" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L88" } ], "type": { @@ -7918,7 +9523,7 @@ } }, { - "id": 529, + "id": 567, "name": "timeout", "variant": "declaration", "kind": 1024, @@ -7928,9 +9533,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 82, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L66" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L82" } ], "type": { @@ -7939,7 +9544,7 @@ } }, { - "id": 528, + "id": 566, "name": "transport", "variant": "declaration", "kind": 1024, @@ -7949,23 +9554,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L65" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L81" } ], "type": { "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, + "target": 758, "name": "WebSocketLikeConstructor", "package": "@supabase/realtime-js" } }, { - "id": 546, + "id": 588, "name": "worker", "variant": "declaration", "kind": 1024, @@ -7975,9 +9577,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 95, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L78" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L95" } ], "type": { @@ -7986,7 +9588,7 @@ } }, { - "id": 547, + "id": 589, "name": "workerUrl", "variant": "declaration", "kind": 1024, @@ -7996,9 +9598,9 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 96, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L79" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L96" } ], "type": { @@ -8011,23 +9613,23 @@ { "title": "Properties", "children": [ - 548, 533, 532, 545, 535, 530, 543, 531, 544, 539, 534, 529, 528, 546, 547 + 590, 575, 574, 587, 577, 569, 568, 585, 573, 586, 581, 576, 567, 566, 588, 589 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 80, "character": 36, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L64" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L80" } ] } } }, { - "id": 551, + "id": 593, "name": "RealtimeMessage", "variant": "declaration", "kind": 2097152, @@ -8037,20 +9639,20 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 594, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 554, + "id": 596, "name": "event", "variant": "declaration", "kind": 1024, @@ -8060,7 +9662,7 @@ "fileName": "src/RealtimeClient.ts", "line": 33, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L33" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L33" } ], "type": { @@ -8069,7 +9671,7 @@ } }, { - "id": 557, + "id": 599, "name": "join_ref", "variant": "declaration", "kind": 1024, @@ -8081,7 +9683,7 @@ "fileName": "src/RealtimeClient.ts", "line": 36, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L36" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L36" } ], "type": { @@ -8090,7 +9692,7 @@ } }, { - "id": 555, + "id": 597, "name": "payload", "variant": "declaration", "kind": 1024, @@ -8100,7 +9702,7 @@ "fileName": "src/RealtimeClient.ts", "line": 34, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L34" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L34" } ], "type": { @@ -8109,7 +9711,7 @@ } }, { - "id": 556, + "id": 598, "name": "ref", "variant": "declaration", "kind": 1024, @@ -8119,7 +9721,7 @@ "fileName": "src/RealtimeClient.ts", "line": 35, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L35" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L35" } ], "type": { @@ -8128,7 +9730,7 @@ } }, { - "id": 553, + "id": 595, "name": "topic", "variant": "declaration", "kind": 1024, @@ -8138,7 +9740,7 @@ "fileName": "src/RealtimeClient.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L32" } ], "type": { @@ -8150,7 +9752,7 @@ "groups": [ { "title": "Properties", - "children": [554, 557, 555, 556, 553] + "children": [596, 599, 597, 598, 595] } ], "sources": [ @@ -8158,14 +9760,14 @@ "fileName": "src/RealtimeClient.ts", "line": 31, "character": 30, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L31" } ] } } }, { - "id": 558, + "id": 600, "name": "RealtimePostgresChangesFilter", "variant": "declaration", "kind": 2097152, @@ -8173,14 +9775,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 67, + "line": 71, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L67" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L71" } ], "typeParameters": [ { - "id": 564, + "id": 606, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8192,7 +9794,7 @@ [ { "type": "reference", - "target": 634, + "target": 676, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", "package": "@supabase/realtime-js" }, @@ -8205,14 +9807,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 601, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 560, + "id": 602, "name": "event", "variant": "declaration", "kind": 1024, @@ -8228,21 +9830,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 73, + "line": 77, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L73" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L77" } ], "type": { "type": "reference", - "target": 564, + "target": 606, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 563, + "id": 605, "name": "filter", "variant": "declaration", "kind": 1024, @@ -8260,9 +9862,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 89, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L85" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L89" } ], "type": { @@ -8271,7 +9873,7 @@ } }, { - "id": 561, + "id": 603, "name": "schema", "variant": "declaration", "kind": 1024, @@ -8287,9 +9889,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 77, + "line": 81, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L77" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L81" } ], "type": { @@ -8298,7 +9900,7 @@ } }, { - "id": 562, + "id": 604, "name": "table", "variant": "declaration", "kind": 1024, @@ -8316,9 +9918,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 81, + "line": 85, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L81" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L85" } ], "type": { @@ -8330,22 +9932,22 @@ "groups": [ { "title": "Properties", - "children": [560, 563, 561, 562] + "children": [602, 605, 603, 604] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 69, + "line": 73, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L69" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L73" } ] } } }, { - "id": 565, + "id": 607, "name": "RealtimePostgresChangesPayload", "variant": "declaration", "kind": 2097152, @@ -8353,14 +9955,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "typeParameters": [ { - "id": 566, + "id": 608, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8368,7 +9970,7 @@ "type": { "type": "reflection", "declaration": { - "id": 567, + "id": 609, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8376,14 +9978,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "indexSignatures": [ { - "id": 568, + "id": 610, "name": "__index", "variant": "signature", "kind": 8192, @@ -8391,14 +9993,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 66, "character": 55, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L62" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L66" } ], "parameters": [ { - "id": 569, + "id": 611, "name": "key", "variant": "param", "kind": 32768, @@ -8424,11 +10026,11 @@ "types": [ { "type": "reference", - "target": 570, + "target": 612, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8439,11 +10041,11 @@ }, { "type": "reference", - "target": 580, + "target": 622, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8454,11 +10056,11 @@ }, { "type": "reference", - "target": 589, + "target": 631, "typeArguments": [ { "type": "reference", - "target": 566, + "target": 608, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8471,7 +10073,7 @@ } }, { - "id": 589, + "id": 631, "name": "RealtimePostgresDeletePayload", "variant": "declaration", "kind": 2097152, @@ -8479,14 +10081,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "typeParameters": [ { - "id": 595, + "id": 637, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8494,7 +10096,7 @@ "type": { "type": "reflection", "declaration": { - "id": 596, + "id": 638, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8502,14 +10104,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "indexSignatures": [ { - "id": 597, + "id": 639, "name": "__index", "variant": "signature", "kind": 8192, @@ -8517,14 +10119,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 55, + "line": 59, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L55" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L59" } ], "parameters": [ { - "id": 598, + "id": 640, "name": "key", "variant": "param", "kind": 32768, @@ -8560,14 +10162,14 @@ { "type": "reflection", "declaration": { - "id": 590, + "id": 632, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 591, + "id": 633, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8575,9 +10177,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 61, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L57" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L61" } ], "type": { @@ -8587,7 +10189,7 @@ [ { "type": "reference", - "target": 638, + "target": 680, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", "package": "@supabase/realtime-js" }, @@ -8597,7 +10199,7 @@ } }, { - "id": 592, + "id": 634, "name": "new", "variant": "declaration", "kind": 1024, @@ -8605,15 +10207,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ], "type": { "type": "reflection", "declaration": { - "id": 593, + "id": 635, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8621,16 +10223,16 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 58, + "line": 62, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L58" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L62" } ] } } }, { - "id": 594, + "id": 636, "name": "old", "variant": "declaration", "kind": 1024, @@ -8638,9 +10240,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 59, + "line": 63, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L59" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L63" } ], "type": { @@ -8652,7 +10254,7 @@ "typeArguments": [ { "type": "reference", - "target": 595, + "target": 637, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -8666,15 +10268,15 @@ "groups": [ { "title": "Properties", - "children": [591, 592, 594] + "children": [633, 634, 636] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 56, + "line": 60, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L56" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L60" } ] } @@ -8683,7 +10285,7 @@ } }, { - "id": 570, + "id": 612, "name": "RealtimePostgresInsertPayload", "variant": "declaration", "kind": 2097152, @@ -8691,14 +10293,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "typeParameters": [ { - "id": 576, + "id": 618, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8706,7 +10308,7 @@ "type": { "type": "reflection", "declaration": { - "id": 577, + "id": 619, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8714,14 +10316,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "indexSignatures": [ { - "id": 578, + "id": 620, "name": "__index", "variant": "signature", "kind": 8192, @@ -8729,14 +10331,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 41, + "line": 45, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L41" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L45" } ], "parameters": [ { - "id": 579, + "id": 621, "name": "key", "variant": "param", "kind": 32768, @@ -8772,14 +10374,14 @@ { "type": "reflection", "declaration": { - "id": 571, + "id": 613, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 572, + "id": 614, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8787,9 +10389,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 43, + "line": 47, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L43" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L47" } ], "type": { @@ -8799,7 +10401,7 @@ [ { "type": "reference", - "target": 636, + "target": 678, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", "package": "@supabase/realtime-js" }, @@ -8809,7 +10411,7 @@ } }, { - "id": 573, + "id": 615, "name": "new", "variant": "declaration", "kind": 1024, @@ -8817,21 +10419,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 48, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L44" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L48" } ], "type": { "type": "reference", - "target": 576, + "target": 618, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 574, + "id": 616, "name": "old", "variant": "declaration", "kind": 1024, @@ -8839,15 +10441,15 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ], "type": { "type": "reflection", "declaration": { - "id": 575, + "id": 617, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8855,9 +10457,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 45, + "line": 49, "character": 9, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L45" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L49" } ] } @@ -8867,15 +10469,15 @@ "groups": [ { "title": "Properties", - "children": [572, 573, 574] + "children": [614, 615, 616] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 42, + "line": 46, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L42" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L46" } ] } @@ -8884,7 +10486,7 @@ } }, { - "id": 580, + "id": 622, "name": "RealtimePostgresUpdatePayload", "variant": "declaration", "kind": 2097152, @@ -8892,14 +10494,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "typeParameters": [ { - "id": 585, + "id": 627, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8907,7 +10509,7 @@ "type": { "type": "reflection", "declaration": { - "id": 586, + "id": 628, "name": "__type", "variant": "declaration", "kind": 65536, @@ -8915,14 +10517,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "indexSignatures": [ { - "id": 587, + "id": 629, "name": "__index", "variant": "signature", "kind": 8192, @@ -8930,14 +10532,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 48, + "line": 52, "character": 54, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L48" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L52" } ], "parameters": [ { - "id": 588, + "id": 630, "name": "key", "variant": "param", "kind": 32768, @@ -8973,14 +10575,14 @@ { "type": "reflection", "declaration": { - "id": 581, + "id": 623, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 582, + "id": 624, "name": "eventType", "variant": "declaration", "kind": 1024, @@ -8988,9 +10590,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 54, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L50" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L54" } ], "type": { @@ -9000,7 +10602,7 @@ [ { "type": "reference", - "target": 637, + "target": 679, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", "package": "@supabase/realtime-js" }, @@ -9010,7 +10612,7 @@ } }, { - "id": 583, + "id": 625, "name": "new", "variant": "declaration", "kind": 1024, @@ -9018,21 +10620,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 55, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L51" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L55" } ], "type": { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true } }, { - "id": 584, + "id": 626, "name": "old", "variant": "declaration", "kind": 1024, @@ -9040,9 +10642,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 56, "character": 4, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L52" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L56" } ], "type": { @@ -9054,7 +10656,7 @@ "typeArguments": [ { "type": "reference", - "target": 585, + "target": 627, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9068,15 +10670,15 @@ "groups": [ { "title": "Properties", - "children": [582, 583, 584] + "children": [624, 625, 626] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 49, + "line": 53, "character": 39, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L49" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L53" } ] } @@ -9085,7 +10687,7 @@ } }, { - "id": 599, + "id": 641, "name": "RealtimePresenceJoinPayload", "variant": "declaration", "kind": 2097152, @@ -9095,12 +10697,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "typeParameters": [ { - "id": 605, + "id": 647, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9108,7 +10710,7 @@ "type": { "type": "reflection", "declaration": { - "id": 606, + "id": 648, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9118,12 +10720,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 50, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "indexSignatures": [ { - "id": 607, + "id": 649, "name": "__index", "variant": "signature", "kind": 8192, @@ -9133,12 +10735,12 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 52, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ], "parameters": [ { - "id": 608, + "id": 650, "name": "key", "variant": "param", "kind": 32768, @@ -9162,14 +10764,14 @@ "type": { "type": "reflection", "declaration": { - "id": 600, + "id": 642, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 603, + "id": 645, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -9179,7 +10781,7 @@ "fileName": "src/RealtimePresence.ts", "line": 24, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L24" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L24" } ], "type": { @@ -9193,7 +10795,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9205,7 +10807,7 @@ } }, { - "id": 601, + "id": 643, "name": "event", "variant": "declaration", "kind": 1024, @@ -9215,7 +10817,7 @@ "fileName": "src/RealtimePresence.ts", "line": 22, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L22" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L22" } ], "type": { @@ -9225,7 +10827,7 @@ [ { "type": "reference", - "target": 641, + "target": 683, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", "package": "@supabase/realtime-js" }, @@ -9235,7 +10837,7 @@ } }, { - "id": 602, + "id": 644, "name": "key", "variant": "declaration", "kind": 1024, @@ -9245,7 +10847,7 @@ "fileName": "src/RealtimePresence.ts", "line": 23, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L23" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L23" } ], "type": { @@ -9254,7 +10856,7 @@ } }, { - "id": 604, + "id": 646, "name": "newPresences", "variant": "declaration", "kind": 1024, @@ -9264,7 +10866,7 @@ "fileName": "src/RealtimePresence.ts", "line": 25, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L25" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L25" } ], "type": { @@ -9278,7 +10880,7 @@ "typeArguments": [ { "type": "reference", - "target": 605, + "target": 647, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9293,7 +10895,7 @@ "groups": [ { "title": "Properties", - "children": [603, 601, 602, 604] + "children": [645, 643, 644, 646] } ], "sources": [ @@ -9301,14 +10903,14 @@ "fileName": "src/RealtimePresence.ts", "line": 21, "character": 76, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L21" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L21" } ] } } }, { - "id": 609, + "id": 651, "name": "RealtimePresenceLeavePayload", "variant": "declaration", "kind": 2097152, @@ -9318,12 +10920,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "typeParameters": [ { - "id": 615, + "id": 657, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9331,7 +10933,7 @@ "type": { "type": "reflection", "declaration": { - "id": 616, + "id": 658, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9341,12 +10943,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 51, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "indexSignatures": [ { - "id": 617, + "id": 659, "name": "__index", "variant": "signature", "kind": 8192, @@ -9356,12 +10958,12 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 53, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ], "parameters": [ { - "id": 618, + "id": 660, "name": "key", "variant": "param", "kind": 32768, @@ -9385,14 +10987,14 @@ "type": { "type": "reflection", "declaration": { - "id": 610, + "id": 652, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 613, + "id": 655, "name": "currentPresences", "variant": "declaration", "kind": 1024, @@ -9402,7 +11004,7 @@ "fileName": "src/RealtimePresence.ts", "line": 31, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L31" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L31" } ], "type": { @@ -9416,7 +11018,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9428,7 +11030,7 @@ } }, { - "id": 611, + "id": 653, "name": "event", "variant": "declaration", "kind": 1024, @@ -9438,7 +11040,7 @@ "fileName": "src/RealtimePresence.ts", "line": 29, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L29" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L29" } ], "type": { @@ -9448,7 +11050,7 @@ [ { "type": "reference", - "target": 642, + "target": 684, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", "package": "@supabase/realtime-js" }, @@ -9458,7 +11060,7 @@ } }, { - "id": 612, + "id": 654, "name": "key", "variant": "declaration", "kind": 1024, @@ -9468,7 +11070,7 @@ "fileName": "src/RealtimePresence.ts", "line": 30, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L30" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L30" } ], "type": { @@ -9477,7 +11079,7 @@ } }, { - "id": 614, + "id": 656, "name": "leftPresences", "variant": "declaration", "kind": 1024, @@ -9487,7 +11089,7 @@ "fileName": "src/RealtimePresence.ts", "line": 32, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L32" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L32" } ], "type": { @@ -9501,7 +11103,7 @@ "typeArguments": [ { "type": "reference", - "target": 615, + "target": 657, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9516,7 +11118,7 @@ "groups": [ { "title": "Properties", - "children": [613, 611, 612, 614] + "children": [655, 653, 654, 656] } ], "sources": [ @@ -9524,14 +11126,14 @@ "fileName": "src/RealtimePresence.ts", "line": 28, "character": 77, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L28" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L28" } ] } } }, { - "id": 619, + "id": 661, "name": "RealtimePresenceState", "variant": "declaration", "kind": 2097152, @@ -9541,12 +11143,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "typeParameters": [ { - "id": 623, + "id": 665, "name": "T", "variant": "typeParam", "kind": 131072, @@ -9554,7 +11156,7 @@ "type": { "type": "reflection", "declaration": { - "id": 624, + "id": 666, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9564,12 +11166,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 44, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 625, + "id": 667, "name": "__index", "variant": "signature", "kind": 8192, @@ -9579,12 +11181,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 46, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "parameters": [ { - "id": 626, + "id": 668, "name": "key", "variant": "param", "kind": 32768, @@ -9606,7 +11208,7 @@ "default": { "type": "reflection", "declaration": { - "id": 627, + "id": 669, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9616,7 +11218,7 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 69, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ] } @@ -9626,7 +11228,7 @@ "type": { "type": "reflection", "declaration": { - "id": 620, + "id": 662, "name": "__type", "variant": "declaration", "kind": 65536, @@ -9636,12 +11238,12 @@ "fileName": "src/RealtimePresence.ts", "line": 17, "character": 75, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L17" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L17" } ], "indexSignatures": [ { - "id": 621, + "id": 663, "name": "__index", "variant": "signature", "kind": 8192, @@ -9651,12 +11253,12 @@ "fileName": "src/RealtimePresence.ts", "line": 18, "character": 2, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimePresence.ts#L18" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimePresence.ts#L18" } ], "parameters": [ { - "id": 622, + "id": 664, "name": "key", "variant": "param", "kind": 32768, @@ -9678,7 +11280,7 @@ "typeArguments": [ { "type": "reference", - "target": 623, + "target": 665, "name": "T", "package": "@supabase/realtime-js", "refersToTypeParameter": true @@ -9694,7 +11296,7 @@ } }, { - "id": 628, + "id": 670, "name": "RealtimeRemoveChannelResponse", "variant": "declaration", "kind": 2097152, @@ -9704,7 +11306,7 @@ "fileName": "src/RealtimeClient.ts", "line": 39, "character": 12, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeClient.ts#L39" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeClient.ts#L39" } ], "type": { @@ -9726,7 +11328,7 @@ } }, { - "id": 648, + "id": 690, "name": "REALTIME_CHANNEL_STATES", "variant": "declaration", "kind": 32, @@ -9736,9 +11338,9 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 111, + "line": 115, "character": 13, - "url": "https://github.com/supabase/realtime-js/blob/d3026be84cd2ed2ac1b22deda4bbfc18e0226d86/src/RealtimeChannel.ts#L111" + "url": "https://github.com/supabase/realtime-js/blob/1fb25b91ea51425f8a2407243d11f8412243798a/src/RealtimeChannel.ts#L115" } ], "type": { @@ -9760,26 +11362,30 @@ "groups": [ { "title": "Enumerations", - "children": [629, 634, 639, 643] + "children": [671, 676, 681, 685] }, { "title": "Classes", - "children": [59, 369, 1] + "children": [59, 372, 1, 691] + }, + { + "title": "Interfaces", + "children": [708, 758] }, { "title": "Type Aliases", - "children": [355, 368, 526, 551, 558, 565, 589, 570, 580, 599, 609, 619, 628] + "children": [358, 371, 564, 593, 600, 607, 631, 612, 622, 641, 651, 661, 670] }, { "title": "Variables", - "children": [648] + "children": [690] } ], "packageName": "@supabase/realtime-js", "readme": [ { "kind": "text", - "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" + "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Realtime Client

\n\n

Send ephemeral messages with Broadcast, track and synchronize state with Presence, and listen to database changes with Postgres Change Data Capture (CDC).

\n\n

\n Guides\n ·\n Reference Docs\n ·\n Multiplayer Demo\n

\n

\n\n
\n\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
\n\n# Overview\n\nThis client enables you to use the following Supabase Realtime's features:\n\n- **Broadcast**: send ephemeral messages from client to clients with minimal latency. Use cases include sharing cursor positions between users.\n- **Presence**: track and synchronize shared state across clients with the help of CRDTs. Use cases include tracking which users are currently viewing a specific webpage.\n- **Postgres Change Data Capture (CDC)**: listen for changes in your PostgreSQL database and send them to clients.\n\n# Usage\n\n## Installing the Package\n\n" }, { "kind": "code", @@ -9863,7 +11469,7 @@ }, { "kind": "code", - "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { broadcast: { ack: false, self: false } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" + "text": "```js\n// Setup...\n\nconst channel = client.channel('broadcast-test', { config: { broadcast: { ack: false, self: false } } })\n\nchannel.on('broadcast', { event: 'some-event' }, (payload) =>\n console.log(payload)\n)\n\nchannel.subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n // Send message to other clients listening to 'broadcast-test' channel\n await channel.send({\n type: 'broadcast',\n event: 'some-event',\n payload: { hello: 'world' },\n })\n }\n})\n```" }, { "kind": "text", @@ -10799,909 +12405,1217 @@ "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "default.teardown" }, - "355": { + "358": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelOptions" }, - "356": { + "359": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "357": { + "360": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.config" }, - "358": { + "361": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "359": { + "362": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.broadcast" }, - "360": { + "363": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "361": { + "364": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.self" }, - "362": { + "365": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.ack" }, - "363": { + "366": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.presence" }, - "364": { + "367": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "365": { + "368": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.key" }, - "366": { + "369": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.enabled" }, - "367": { + "370": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.private" }, - "368": { + "371": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimeChannelSendResponse" }, - "369": { + "372": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "370": { + "373": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.__constructor" }, - "371": { + "374": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default" }, - "372": { + "375": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "endPoint" }, - "373": { + "376": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "options" }, - "374": { + "377": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessTokenValue" }, - "375": { + "378": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.apiKey" }, - "376": { + "379": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channels" }, - "377": { + "380": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endPoint" }, - "378": { + "381": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.httpEndpoint" }, - "379": { + "382": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.headers" }, - "380": { + "383": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "381": { + "384": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "383": { + "386": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.params" }, - "384": { + "387": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "385": { + "388": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "387": { + "390": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.timeout" }, - "388": { + "391": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.transport" }, - "389": { + "392": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatIntervalMs" }, - "390": { + "393": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatTimer" }, - "391": { + "394": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.pendingHeartbeatRef" }, - "392": { + "395": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.heartbeatCallback" }, - "393": { + "396": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "394": { + "397": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "395": { + "398": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "396": { + "399": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.ref" }, - "397": { + "400": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectTimer" }, - "398": { + "401": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logger" }, - "399": { + "402": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.logLevel" }, - "400": { + "403": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.encode" }, - "401": { + "404": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.decode" }, - "402": { + "405": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.reconnectAfterMs" }, - "403": { + "406": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.conn" }, - "404": { + "407": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendBuffer" }, - "405": { + "408": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.serializer" }, - "406": { + "409": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.stateChangeCallbacks" }, - "407": { + "410": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "408": { + "411": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.open" }, - "409": { + "412": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.close" }, - "410": { + "413": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.error" }, - "411": { + "414": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.message" }, - "412": { + "415": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.fetch" }, - "413": { + "416": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "414": { + "417": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, - "415": { + "418": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, - "416": { + "419": { "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, - "417": { + "420": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, - "418": { + "421": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, - "419": { + "422": { "sourceFileName": "node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, - "420": { + "423": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.accessToken" }, - "421": { + "424": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "422": { + "425": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "423": { + "426": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.worker" }, - "424": { + "427": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerUrl" }, - "425": { + "428": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.workerRef" }, - "426": { + "432": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "427": { + "433": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connect" }, - "428": { + "434": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "429": { + "435": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.endpointURL" }, - "430": { + "436": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "431": { + "437": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.disconnect" }, - "432": { + "438": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "code" }, - "433": { + "439": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "reason" }, - "434": { + "440": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "435": { + "441": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.getChannels" }, - "436": { + "442": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "437": { + "443": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeChannel" }, - "438": { + "444": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "channel" }, - "439": { + "445": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "440": { + "446": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.removeAllChannels" }, - "441": { + "447": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "442": { + "448": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.log" }, - "443": { + "449": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "kind" }, - "444": { + "450": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "msg" }, - "445": { + "451": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "446": { + "452": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "447": { + "453": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.connectionState" }, - "448": { + "454": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "449": { + "455": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.isConnected" }, - "450": { + "456": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "457": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isConnecting" + }, + "458": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "459": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "default.isDisconnecting" + }, + "460": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "451": { + "461": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.channel" }, - "452": { + "462": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "topic" }, - "453": { + "463": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "params" }, - "454": { + "464": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "455": { + "465": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.push" }, - "456": { + "466": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "data" }, - "457": { + "467": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "458": { + "468": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.setAuth" }, - "459": { + "469": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "token" }, - "460": { + "470": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "461": { + "471": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.sendHeartbeat" }, - "462": { + "472": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "463": { + "473": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.onHeartbeat" }, - "464": { + "474": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "callback" }, - "465": { + "475": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "466": { + "476": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "467": { + "477": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "status" }, - "468": { + "478": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "469": { + "479": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "default.flushSendBuffer" }, - "526": { + "564": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeClientOptions" }, - "527": { + "565": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "528": { + "566": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.transport" }, - "529": { + "567": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.timeout" }, - "530": { + "568": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.heartbeatIntervalMs" }, - "531": { + "569": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type.heartbeatCallback" + }, + "570": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "571": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "__type" + }, + "572": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "status" + }, + "573": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logger" }, - "532": { + "574": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.encode" }, - "533": { + "575": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.decode" }, - "534": { + "576": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.reconnectAfterMs" }, - "535": { + "577": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.headers" }, - "536": { + "578": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "537": { + "579": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "539": { + "581": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.params" }, - "540": { + "582": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "541": { + "583": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.__index" }, - "543": { + "585": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.log_level" }, - "544": { + "586": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.logLevel" }, - "545": { + "587": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.fetch" }, - "546": { + "588": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.worker" }, - "547": { + "589": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.workerUrl" }, - "548": { + "590": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.accessToken" }, - "549": { + "591": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "550": { + "592": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "551": { + "593": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeMessage" }, - "552": { + "594": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type" }, - "553": { + "595": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.topic" }, - "554": { + "596": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.event" }, - "555": { + "597": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.payload" }, - "556": { + "598": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.ref" }, - "557": { + "599": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "__type.join_ref" }, - "558": { + "600": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesFilter" }, - "559": { + "601": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "560": { + "602": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.event" }, - "561": { + "603": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.schema" }, - "562": { + "604": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.table" }, - "563": { + "605": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.filter" }, - "564": { + "606": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "565": { + "607": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresChangesPayload" }, - "566": { + "608": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "567": { + "609": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "568": { + "610": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "570": { + "612": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresInsertPayload" }, - "571": { + "613": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "572": { + "614": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "573": { + "615": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "574": { + "616": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "575": { + "617": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "576": { + "618": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "577": { + "619": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "578": { + "620": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "580": { + "622": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresUpdatePayload" }, - "581": { + "623": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "582": { + "624": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "583": { + "625": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "584": { + "626": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "585": { + "627": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "586": { + "628": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "587": { + "629": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "589": { + "631": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "RealtimePostgresDeletePayload" }, - "590": { + "632": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "591": { + "633": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.eventType" }, - "592": { + "634": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.new" }, - "593": { + "635": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "594": { + "636": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.old" }, - "595": { + "637": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "T" }, - "596": { + "638": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type" }, - "597": { + "639": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "__type.__index" }, - "599": { + "641": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceJoinPayload" }, - "600": { + "642": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "601": { + "643": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "602": { + "644": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "603": { + "645": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "604": { + "646": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.newPresences" }, - "605": { + "647": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "606": { + "648": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "607": { + "649": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "609": { + "651": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceLeavePayload" }, - "610": { + "652": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "611": { + "653": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.event" }, - "612": { + "654": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.key" }, - "613": { + "655": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.currentPresences" }, - "614": { + "656": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.leftPresences" }, - "615": { + "657": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "616": { + "658": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "617": { + "659": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "619": { + "661": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "RealtimePresenceState" }, - "620": { + "662": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "621": { + "663": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "623": { + "665": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "T" }, - "624": { + "666": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "625": { + "667": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type.__index" }, - "627": { + "669": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "__type" }, - "628": { + "670": { "sourceFileName": "src/RealtimeClient.ts", "qualifiedName": "RealtimeRemoveChannelResponse" }, - "629": { + "671": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES" }, - "630": { + "672": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" }, - "631": { + "673": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" }, - "632": { + "674": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" }, - "633": { + "675": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" }, - "634": { + "676": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, - "635": { + "677": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" }, - "636": { + "678": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, - "637": { + "679": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, - "638": { + "680": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, - "639": { + "681": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" }, - "640": { + "682": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" }, - "641": { + "683": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, - "642": { + "684": { "sourceFileName": "src/RealtimePresence.ts", "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, - "643": { + "685": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES" }, - "644": { + "686": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" }, - "645": { + "687": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" }, - "646": { + "688": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" }, - "647": { + "689": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" }, - "648": { + "690": { "sourceFileName": "src/RealtimeChannel.ts", "qualifiedName": "REALTIME_CHANNEL_STATES" + }, + "691": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory" + }, + "694": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "695": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.getWebSocketConstructor" + }, + "696": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "697": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "__type" + }, + "698": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "url" + }, + "699": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "protocols" + }, + "700": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "701": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.createWebSocket" + }, + "702": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "url" + }, + "703": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "protocols" + }, + "704": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "705": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketFactory.isWebSocketSupported" + }, + "708": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike" + }, + "709": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CONNECTING" + }, + "710": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.OPEN" + }, + "711": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSING" + }, + "712": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.CLOSED" + }, + "713": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.readyState" + }, + "714": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.url" + }, + "715": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.protocol" + }, + "716": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "717": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.close" + }, + "718": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "code" + }, + "719": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "reason" + }, + "720": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "721": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.send" + }, + "722": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "data" + }, + "723": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onopen" + }, + "724": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "725": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "726": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "727": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "728": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onmessage" + }, + "729": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "730": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "731": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "732": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "733": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onclose" + }, + "734": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "735": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "736": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "737": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "738": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.onerror" + }, + "739": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "740": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "741": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "this" + }, + "742": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "ev" + }, + "743": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "744": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.addEventListener" + }, + "745": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "746": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "747": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "748": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.removeEventListener" + }, + "749": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "type" + }, + "750": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "listener" + }, + "751": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.binaryType" + }, + "752": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.bufferedAmount" + }, + "753": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.extensions" + }, + "754": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "WebSocketLike.dispatchEvent" + }, + "755": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "756": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "__type" + }, + "757": { + "sourceFileName": "src/lib/websocket-factory.ts", + "qualifiedName": "event" + }, + "758": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "759": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "760": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor" + }, + "761": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "address" + }, + "762": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "subprotocols" + }, + "763": { + "sourceFileName": "src/RealtimeClient.ts", + "qualifiedName": "WebSocketLikeConstructor.__index" } }, "files": { diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage.json b/apps/docs/spec/enrichments/tsdoc_v2/storage.json index ef7a269196d92..4542211e63d99 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/storage.json @@ -13,14 +13,14 @@ "flags": {}, "children": [ { - "id": 504, + "id": 534, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 505, + "id": 535, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -29,19 +29,20 @@ { "fileName": "src/lib/errors.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 506, + "id": 536, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 537, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52,7 +53,7 @@ } }, { - "id": 508, + "id": 538, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -63,7 +64,7 @@ } }, { - "id": 509, + "id": 539, "name": "statusCode", "kind": 32768, "kindString": "Parameter", @@ -76,24 +77,24 @@ ], "type": { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 510, + "id": 540, "name": "status", "kind": 1024, "kindString": "Property", @@ -102,7 +103,8 @@ { "fileName": "src/lib/errors.ts", "line": 15, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L15" } ], "type": { @@ -111,7 +113,7 @@ } }, { - "id": 511, + "id": 541, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -120,7 +122,8 @@ { "fileName": "src/lib/errors.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L16" } ], "type": { @@ -129,7 +132,7 @@ } }, { - "id": 512, + "id": 542, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -138,12 +141,13 @@ { "fileName": "src/lib/errors.ts", "line": 25, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L25" } ], "signatures": [ { - "id": 513, + "id": 543, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -151,14 +155,14 @@ "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 546, "name": "message", "kind": 1024, "kindString": "Property", @@ -167,7 +171,8 @@ { "fileName": "src/lib/errors.ts", "line": 28, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L28" } ], "type": { @@ -177,7 +182,7 @@ "defaultValue": "..." }, { - "id": 515, + "id": 545, "name": "name", "kind": 1024, "kindString": "Property", @@ -186,7 +191,8 @@ { "fileName": "src/lib/errors.ts", "line": 27, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L27" } ], "type": { @@ -196,7 +202,7 @@ "defaultValue": "..." }, { - "id": 517, + "id": 547, "name": "status", "kind": 1024, "kindString": "Property", @@ -205,7 +211,8 @@ { "fileName": "src/lib/errors.ts", "line": 29, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L29" } ], "type": { @@ -215,7 +222,7 @@ "defaultValue": "..." }, { - "id": 518, + "id": 548, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -224,7 +231,8 @@ { "fileName": "src/lib/errors.ts", "line": 30, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L30" } ], "type": { @@ -237,8 +245,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [516, 515, 517, 518] + "children": [546, 545, 547, 548] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L26" } ] } @@ -250,44 +265,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [505] + "children": [535] }, { "title": "Properties", - "kind": 1024, - "children": [510, 511] + "children": [540, 541] }, { "title": "Methods", - "kind": 2048, - "children": [512] + "children": [542] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L14" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 335, + "id": 351, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 336, + "id": 352, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -296,19 +309,20 @@ { "fileName": "src/StorageClient.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L10" } ], "signatures": [ { - "id": 337, + "id": 353, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 338, + "id": 354, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -319,7 +333,7 @@ } }, { - "id": 339, + "id": 355, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -327,20 +341,28 @@ "type": { "type": "reflection", "declaration": { - "id": 340, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 12, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L12" + } + ], "indexSignature": { - "id": 341, + "id": 357, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 342, + "id": 358, "name": "key", "kind": 32768, "flags": {}, @@ -360,7 +382,7 @@ "defaultValue": "{}" }, { - "id": 343, + "id": 359, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -370,34 +392,41 @@ "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 345, + "id": 361, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 346, + "id": 362, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 347, + "id": 363, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -406,9 +435,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -417,14 +446,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -432,7 +461,7 @@ } }, { - "id": 348, + "id": 364, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -447,7 +476,7 @@ ], "type": { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" }, "overwrites": { @@ -464,7 +493,7 @@ } }, { - "id": 379, + "id": 398, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -472,30 +501,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 380, + "id": 399, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 381, + "id": 400, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -503,7 +553,7 @@ } }, { - "id": 382, + "id": 401, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -511,14 +561,14 @@ "type": { "type": "reflection", "declaration": { - "id": 383, + "id": 402, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 405, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -526,13 +576,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -553,7 +609,7 @@ } }, { - "id": 385, + "id": 404, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -561,13 +617,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -589,19 +651,25 @@ } }, { - "id": 384, + "id": 403, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -610,7 +678,7 @@ } }, { - "id": 387, + "id": 406, "name": "type", "kind": 1024, "kindString": "Property", @@ -618,18 +686,36 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType" } } @@ -637,8 +723,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [386, 385, 384, 387] + "children": [405, 404, 403, 406] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -655,14 +748,14 @@ { "type": "reflection", "declaration": { - "id": 388, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 408, "name": "data", "kind": 1024, "kindString": "Property", @@ -670,8 +763,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -679,7 +773,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -687,13 +781,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 390, + "id": 409, "name": "error", "kind": 1024, "kindString": "Property", @@ -701,8 +795,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -714,8 +809,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [389, 390] + "children": [408, 409] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -723,14 +825,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 411, "name": "data", "kind": 1024, "kindString": "Property", @@ -738,8 +840,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -748,7 +851,7 @@ } }, { - "id": 393, + "id": 412, "name": "error", "kind": 1024, "kindString": "Property", @@ -756,13 +859,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -770,8 +874,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [392, 393] + "children": [411, 412] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -779,25 +890,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 48, "name": "default.createBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 44, + "id": 47, "name": "default.createBucket" } }, { - "id": 421, + "id": 440, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -805,29 +916,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 422, + "id": 441, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 423, + "id": 442, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -844,14 +974,14 @@ { "type": "reflection", "declaration": { - "id": 424, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 425, + "id": 444, "name": "data", "kind": 1024, "kindString": "Property", @@ -859,21 +989,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 445, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 446, "name": "message", "kind": 1024, "kindString": "Property", @@ -881,8 +1012,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -894,15 +1026,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [427] + "children": [446] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 428, + "id": 447, "name": "error", "kind": 1024, "kindString": "Property", @@ -910,8 +1049,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -923,8 +1063,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [425, 428] + "children": [444, 447] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -932,14 +1079,14 @@ { "type": "reflection", "declaration": { - "id": 429, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 430, + "id": 449, "name": "data", "kind": 1024, "kindString": "Property", @@ -947,8 +1094,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -957,7 +1105,7 @@ } }, { - "id": 431, + "id": 450, "name": "error", "kind": 1024, "kindString": "Property", @@ -965,13 +1113,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -979,8 +1128,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [430, 431] + "children": [449, 450] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -988,25 +1144,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 87, + "id": 90, "name": "default.deleteBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 86, + "id": 89, "name": "default.deleteBucket" } }, { - "id": 410, + "id": 429, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -1014,29 +1170,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 411, + "id": 430, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 412, + "id": 431, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -1053,14 +1220,14 @@ { "type": "reflection", "declaration": { - "id": 413, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 414, + "id": 433, "name": "data", "kind": 1024, "kindString": "Property", @@ -1068,21 +1235,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 435, "name": "message", "kind": 1024, "kindString": "Property", @@ -1090,8 +1258,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -1103,15 +1272,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [416] + "children": [435] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 417, + "id": 436, "name": "error", "kind": 1024, "kindString": "Property", @@ -1119,8 +1295,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -1132,8 +1309,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [414, 417] + "children": [433, 436] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -1141,14 +1325,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 437, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 438, "name": "data", "kind": 1024, "kindString": "Property", @@ -1156,8 +1340,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -1166,7 +1351,7 @@ } }, { - "id": 420, + "id": 439, "name": "error", "kind": 1024, "kindString": "Property", @@ -1174,13 +1359,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1188,8 +1374,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [419, 420] + "children": [438, 439] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -1197,25 +1390,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 76, + "id": 79, "name": "default.emptyBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 75, + "id": 78, "name": "default.emptyBucket" } }, { - "id": 349, + "id": 365, "name": "from", "kind": 2048, "kindString": "Method", @@ -1224,28 +1417,39 @@ { "fileName": "src/StorageClient.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L24" } ], "signatures": [ { - "id": 350, + "id": 366, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform file operation in a bucket." + "summary": [ + { + "kind": "text", + "text": "Perform file operation in a bucket." + } + ] }, "parameters": [ { - "id": 351, + "id": 367, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The bucket id to operate on.\n" + "summary": [ + { + "kind": "text", + "text": "The bucket id to operate on." + } + ] }, "type": { "type": "intrinsic", @@ -1255,14 +1459,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 370, + "id": 389, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -1270,29 +1474,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 371, + "id": 390, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 372, + "id": 391, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -1309,14 +1524,14 @@ { "type": "reflection", "declaration": { - "id": 373, + "id": 392, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 374, + "id": 393, "name": "data", "kind": 1024, "kindString": "Property", @@ -1324,18 +1539,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 375, + "id": 394, "name": "error", "kind": 1024, "kindString": "Property", @@ -1343,8 +1559,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -1356,8 +1573,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [374, 375] + "children": [393, 394] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -1365,14 +1589,14 @@ { "type": "reflection", "declaration": { - "id": 376, + "id": 395, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 377, + "id": 396, "name": "data", "kind": 1024, "kindString": "Property", @@ -1380,8 +1604,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -1390,7 +1615,7 @@ } }, { - "id": 378, + "id": 397, "name": "error", "kind": 1024, "kindString": "Property", @@ -1398,13 +1623,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1412,8 +1638,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [377, 378] + "children": [396, 397] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -1421,25 +1654,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 36, + "id": 39, "name": "default.getBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 35, + "id": 38, "name": "default.getBucket" } }, { - "id": 362, + "id": 381, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -1447,19 +1680,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 363, + "id": 382, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -1470,14 +1709,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 384, "name": "data", "kind": 1024, "kindString": "Property", @@ -1485,21 +1724,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 366, + "id": 385, "name": "error", "kind": 1024, "kindString": "Property", @@ -1507,8 +1747,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -1520,8 +1761,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 366] + "children": [384, 385] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -1529,14 +1777,14 @@ { "type": "reflection", "declaration": { - "id": 367, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 387, "name": "data", "kind": 1024, "kindString": "Property", @@ -1544,8 +1792,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -1554,7 +1803,7 @@ } }, { - "id": 369, + "id": 388, "name": "error", "kind": 1024, "kindString": "Property", @@ -1562,13 +1811,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1576,8 +1826,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368, 369] + "children": [387, 388] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -1585,25 +1842,74 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 28, + "id": 31, "name": "default.listBuckets" } } ], "inheritedFrom": { "type": "reference", - "id": 27, + "id": 30, "name": "default.listBuckets" } }, { - "id": 394, + "id": 379, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 380, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 351, + "name": "StorageClient" + }, + "inheritedFrom": { + "type": "reference", + "id": 29, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 28, + "name": "default.throwOnError" + } + }, + { + "id": 413, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -1611,29 +1917,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 395, + "id": 414, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 396, + "id": 415, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -1641,7 +1958,7 @@ } }, { - "id": 397, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1649,14 +1966,14 @@ "type": { "type": "reflection", "declaration": { - "id": 398, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 401, + "id": 420, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -1664,13 +1981,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -1691,7 +2014,7 @@ } }, { - "id": 400, + "id": 419, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -1699,13 +2022,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -1727,19 +2056,25 @@ } }, { - "id": 399, + "id": 418, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -1751,8 +2086,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [401, 400, 399] + "children": [420, 419, 418] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -1768,14 +2110,14 @@ { "type": "reflection", "declaration": { - "id": 402, + "id": 421, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 403, + "id": 422, "name": "data", "kind": 1024, "kindString": "Property", @@ -1783,21 +2125,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 405, + "id": 424, "name": "message", "kind": 1024, "kindString": "Property", @@ -1805,8 +2148,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -1818,15 +2162,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [405] + "children": [424] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 406, + "id": 425, "name": "error", "kind": 1024, "kindString": "Property", @@ -1834,8 +2185,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -1847,8 +2199,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [403, 406] + "children": [422, 425] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -1856,14 +2215,14 @@ { "type": "reflection", "declaration": { - "id": 407, + "id": 426, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 408, + "id": 427, "name": "data", "kind": 1024, "kindString": "Property", @@ -1871,8 +2230,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -1881,7 +2241,7 @@ } }, { - "id": 409, + "id": 428, "name": "error", "kind": 1024, "kindString": "Property", @@ -1889,13 +2249,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1903,8 +2264,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [408, 409] + "children": [427, 428] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -1912,20 +2280,20 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 60, + "id": 63, "name": "default.updateBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 59, + "id": 62, "name": "default.updateBucket" } } @@ -1933,20 +2301,19 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [336] + "children": [352] }, { "title": "Methods", - "kind": 2048, - "children": [379, 421, 410, 349, 370, 362, 394] + "children": [398, 440, 429, 365, 389, 381, 379, 413] } ], "sources": [ { "fileName": "src/StorageClient.ts", "line": 9, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L9" } ], "extendedTypes": [ @@ -1958,14 +2325,14 @@ ] }, { - "id": 499, + "id": 529, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 500, + "id": 530, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1974,19 +2341,20 @@ { "fileName": "src/lib/errors.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L4" } ], "signatures": [ { - "id": 501, + "id": 531, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 502, + "id": 532, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1999,7 +2367,7 @@ ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" }, "overwrites": { @@ -2017,47 +2385,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [500] + "children": [530] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 1, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L1" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ], "extendedBy": [ { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" } ] }, { - "id": 520, + "id": 550, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 521, + "id": 551, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2066,19 +2434,20 @@ { "fileName": "src/lib/errors.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L38" } ], "signatures": [ { - "id": 522, + "id": 552, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 523, + "id": 553, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2089,7 +2458,7 @@ } }, { - "id": 524, + "id": 554, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2102,24 +2471,24 @@ ], "type": { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 525, + "id": 555, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2128,7 +2497,8 @@ { "fileName": "src/lib/errors.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L36" } ], "type": { @@ -2140,39 +2510,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [521] + "children": [551] }, { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [555] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 35, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L35" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 433, + "id": 452, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 439, + "id": 458, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2183,7 +2552,8 @@ { "fileName": "src/lib/types.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L9" } ], "type": { @@ -2195,7 +2565,7 @@ } }, { - "id": 440, + "id": 459, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2204,7 +2574,8 @@ { "fileName": "src/lib/types.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L10" } ], "type": { @@ -2213,7 +2584,7 @@ } }, { - "id": 438, + "id": 457, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2224,7 +2595,8 @@ { "fileName": "src/lib/types.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L8" } ], "type": { @@ -2233,7 +2605,7 @@ } }, { - "id": 434, + "id": 453, "name": "id", "kind": 1024, "kindString": "Property", @@ -2242,7 +2614,8 @@ { "fileName": "src/lib/types.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L4" } ], "type": { @@ -2251,7 +2624,7 @@ } }, { - "id": 436, + "id": 455, "name": "name", "kind": 1024, "kindString": "Property", @@ -2260,7 +2633,8 @@ { "fileName": "src/lib/types.ts", "line": 6, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L6" } ], "type": { @@ -2269,7 +2643,7 @@ } }, { - "id": 437, + "id": 456, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2278,7 +2652,8 @@ { "fileName": "src/lib/types.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L7" } ], "type": { @@ -2287,7 +2662,7 @@ } }, { - "id": 442, + "id": 461, "name": "public", "kind": 1024, "kindString": "Property", @@ -2296,7 +2671,8 @@ { "fileName": "src/lib/types.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L12" } ], "type": { @@ -2305,7 +2681,7 @@ } }, { - "id": 435, + "id": 454, "name": "type", "kind": 1024, "kindString": "Property", @@ -2316,17 +2692,18 @@ { "fileName": "src/lib/types.ts", "line": 5, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L5" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType" } }, { - "id": 441, + "id": 460, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2335,7 +2712,8 @@ { "fileName": "src/lib/types.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L11" } ], "type": { @@ -2347,27 +2725,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 440, 438, 434, 436, 437, 442, 435, 441] + "children": [458, 459, 457, 453, 455, 456, 461, 454, 460] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L3" } ] }, { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -2378,7 +2756,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -2390,27 +2769,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] }, { - "id": 484, + "id": 514, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 485, + "id": 515, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2418,47 +2797,53 @@ "isOptional": true }, "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [485] + "children": [515] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, - "character": 17 + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" } ] }, { - "id": 443, + "id": 462, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 445, + "id": 464, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2467,7 +2852,8 @@ { "fileName": "src/lib/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L17" } ], "type": { @@ -2476,7 +2862,7 @@ } }, { - "id": 452, + "id": 471, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -2485,17 +2871,18 @@ { "fileName": "src/lib/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L24" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 449, + "id": 468, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2504,7 +2891,8 @@ { "fileName": "src/lib/types.ts", "line": 21, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L21" } ], "type": { @@ -2513,7 +2901,7 @@ } }, { - "id": 447, + "id": 466, "name": "id", "kind": 1024, "kindString": "Property", @@ -2522,7 +2910,8 @@ { "fileName": "src/lib/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L19" } ], "type": { @@ -2531,7 +2920,7 @@ } }, { - "id": 450, + "id": 469, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2540,7 +2929,8 @@ { "fileName": "src/lib/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L22" } ], "type": { @@ -2549,7 +2939,7 @@ } }, { - "id": 451, + "id": 470, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2558,7 +2948,8 @@ { "fileName": "src/lib/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L23" } ], "type": { @@ -2573,13 +2964,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 444, + "id": 463, "name": "name", "kind": 1024, "kindString": "Property", @@ -2588,7 +2979,8 @@ { "fileName": "src/lib/types.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L16" } ], "type": { @@ -2597,7 +2989,7 @@ } }, { - "id": 446, + "id": 465, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2606,7 +2998,8 @@ { "fileName": "src/lib/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L18" } ], "type": { @@ -2615,7 +3008,7 @@ } }, { - "id": 448, + "id": 467, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2624,7 +3017,8 @@ { "fileName": "src/lib/types.ts", "line": 20, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L20" } ], "type": { @@ -2636,27 +3030,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [445, 452, 449, 447, 450, 451, 444, 446, 448] + "children": [464, 471, 468, 466, 469, 470, 463, 465, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L15" } ] }, { - "id": 453, + "id": 472, "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 457, + "id": 476, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2665,7 +3059,8 @@ { "fileName": "src/lib/types.ts", "line": 31, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L31" } ], "type": { @@ -2674,7 +3069,7 @@ } }, { - "id": 462, + "id": 481, "name": "cache_control", "kind": 1024, "kindString": "Property", @@ -2685,7 +3080,8 @@ { "fileName": "src/lib/types.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L36" } ], "type": { @@ -2694,7 +3090,7 @@ } }, { - "id": 463, + "id": 482, "name": "content_type", "kind": 1024, "kindString": "Property", @@ -2705,7 +3101,8 @@ { "fileName": "src/lib/types.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L37" } ], "type": { @@ -2714,7 +3111,7 @@ } }, { - "id": 459, + "id": 478, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2723,7 +3120,8 @@ { "fileName": "src/lib/types.ts", "line": 33, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L33" } ], "type": { @@ -2732,7 +3130,7 @@ } }, { - "id": 464, + "id": 483, "name": "etag", "kind": 1024, "kindString": "Property", @@ -2743,7 +3141,8 @@ { "fileName": "src/lib/types.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L38" } ], "type": { @@ -2752,7 +3151,7 @@ } }, { - "id": 454, + "id": 473, "name": "id", "kind": 1024, "kindString": "Property", @@ -2761,7 +3160,8 @@ { "fileName": "src/lib/types.ts", "line": 28, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L28" } ], "type": { @@ -2770,7 +3170,7 @@ } }, { - "id": 460, + "id": 479, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2779,7 +3179,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L34" } ], "type": { @@ -2788,7 +3189,7 @@ } }, { - "id": 465, + "id": 484, "name": "last_modified", "kind": 1024, "kindString": "Property", @@ -2799,7 +3200,8 @@ { "fileName": "src/lib/types.ts", "line": 39, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L39" } ], "type": { @@ -2808,7 +3210,7 @@ } }, { - "id": 466, + "id": 485, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2819,7 +3221,8 @@ { "fileName": "src/lib/types.ts", "line": 40, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L40" } ], "type": { @@ -2834,13 +3237,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 456, + "id": 475, "name": "name", "kind": 1024, "kindString": "Property", @@ -2849,7 +3252,8 @@ { "fileName": "src/lib/types.ts", "line": 30, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L30" } ], "type": { @@ -2858,7 +3262,7 @@ } }, { - "id": 461, + "id": 480, "name": "size", "kind": 1024, "kindString": "Property", @@ -2869,7 +3273,8 @@ { "fileName": "src/lib/types.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L35" } ], "type": { @@ -2878,7 +3283,7 @@ } }, { - "id": 458, + "id": 477, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2887,7 +3292,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L32" } ], "type": { @@ -2896,7 +3302,7 @@ } }, { - "id": 455, + "id": 474, "name": "version", "kind": 1024, "kindString": "Property", @@ -2905,7 +3311,8 @@ { "fileName": "src/lib/types.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L29" } ], "type": { @@ -2917,27 +3324,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [457, 462, 463, 459, 464, 454, 460, 465, 466, 456, 461, 458, 455] + "children": [476, 481, 482, 478, 483, 473, 479, 484, 485, 475, 480, 477, 474] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 27, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L27" } ] }, { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -2945,13 +3352,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -2960,7 +3381,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -2968,13 +3389,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -2983,7 +3458,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -2991,13 +3466,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -3006,7 +3487,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3014,13 +3495,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -3035,13 +3522,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -3049,13 +3536,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -3070,13 +3563,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -3084,13 +3577,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -3102,27 +3601,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] }, { - "id": 486, + "id": 516, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 487, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -3130,8 +3629,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 + "line": 126, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L126" } ], "type": { @@ -3143,27 +3643,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [487] + "children": [517] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 17 + "line": 125, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L125" } ] }, { - "id": 479, + "id": 498, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 480, + "id": 499, "name": "limit", "kind": 1024, "kindString": "Property", @@ -3171,11 +3671,21 @@ "isOptional": true }, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "The number of files you want to be returned." + } + ], + "blockTags": [ { - "tag": "default", - "text": "100\n" + "tag": "@default", + "content": [ + { + "kind": "text", + "text": "100" + } + ] } ] }, @@ -3183,7 +3693,8 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L86" } ], "type": { @@ -3192,7 +3703,7 @@ } }, { - "id": 481, + "id": 500, "name": "offset", "kind": 1024, "kindString": "Property", @@ -3200,13 +3711,19 @@ "isOptional": true }, "comment": { - "shortText": "The starting position." + "summary": [ + { + "kind": "text", + "text": "The starting position." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L91" } ], "type": { @@ -3215,7 +3732,7 @@ } }, { - "id": 483, + "id": 502, "name": "search", "kind": 1024, "kindString": "Property", @@ -3223,13 +3740,19 @@ "isOptional": true }, "comment": { - "shortText": "The search string to filter files by." + "summary": [ + { + "kind": "text", + "text": "The search string to filter files by." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L101" } ], "type": { @@ -3238,7 +3761,7 @@ } }, { - "id": 482, + "id": 501, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -3246,18 +3769,24 @@ "isOptional": true }, "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." + "summary": [ + { + "kind": "text", + "text": "The column to sort by. Can be any column inside a FileObject." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 96, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L96" } ], "type": { "type": "reference", - "id": 467, + "id": 486, "name": "SortBy" } } @@ -3265,28 +3794,28 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [480, 481, 483, 482] + "children": [499, 500, 502, 501] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 81, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L81" } ] }, { - "id": 467, - "name": "SortBy", + "id": 503, + "name": "SearchV2Options", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, - "name": "column", + "id": 506, + "name": "cursor", "kind": 1024, "kindString": "Property", "flags": { @@ -3295,8 +3824,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 + "line": 107, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L107" } ], "type": { @@ -3305,8 +3835,8 @@ } }, { - "id": 469, - "name": "order", + "id": 504, + "name": "limit", "kind": 1024, "kindString": "Property", "flags": { @@ -3315,129 +3845,388 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 + "line": 105, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L105" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 505, + "name": "prefix", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L106" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 507, + "name": "with_delimiter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L108" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [506, 504, 505, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 17 + "line": 104, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L104" } ] }, { - "id": 488, - "name": "TransformOptions", + "id": 508, + "name": "SearchV2Result", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, - "name": "format", + "id": 510, + "name": "folders", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 113, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" } ], "type": { - "type": "literal", - "value": "origin" + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 512, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [512] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ] + } + } } }, { - "id": 490, - "name": "height", + "id": 509, + "name": "hasNext", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The height of the image in pixels." - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 112, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L112" } ], "type": { "type": "intrinsic", - "name": "number" + "name": "boolean" } }, { - "id": 492, - "name": "quality", + "id": 513, + "name": "objects", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 114, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L114" } ], "type": { - "type": "intrinsic", - "name": "number" + "type": "array", + "elementType": { + "type": "reference", + "id": 462, + "name": "FileObject" + } } - }, + } + ], + "groups": [ { - "id": 491, - "name": "resize", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ + "title": "Properties", + "children": [510, 509, 513] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L111" + } + ] + }, + { + "id": 486, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 487, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 44, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 488, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [487, 488] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" + } + ] + }, + { + "id": 518, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 523, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" + } + ], + "type": { + "type": "literal", + "value": "origin" + } + }, + { + "id": 520, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 522, + "name": "quality", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 521, + "name": "resize", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" + } + ], + "type": { + "type": "union", + "types": [ { "type": "literal", "value": "cover" @@ -3454,7 +4243,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -3462,13 +4251,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -3480,20 +4275,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] }, { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -3502,7 +4297,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -3520,7 +4316,7 @@ } }, { - "id": 494, + "id": 524, "name": "Camelize", "kind": 4194304, "kindString": "Type alias", @@ -3528,13 +4324,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 151, - "character": 12 + "line": 164, + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L164" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 495, + "id": 525, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -3549,7 +4346,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -3561,7 +4358,7 @@ }, "objectType": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -3580,9 +4377,9 @@ "name": "string" } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } ], "name": "CamelCase" @@ -3590,7 +4387,7 @@ } }, { - "id": 496, + "id": 526, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -3599,19 +4396,20 @@ { "fileName": "src/lib/errors.ts", "line": 10, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L10" } ], "signatures": [ { - "id": 497, + "id": 527, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 528, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -3628,7 +4426,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -3639,30 +4437,27 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [504, 335, 499, 520] + "children": [534, 351, 529, 550] }, { "title": "Interfaces", - "kind": 256, - "children": [433, 477, 484, 443, 453, 470, 486, 479, 467, 488] + "children": [452, 496, 514, 462, 472, 489, 516, 498, 503, 508, 486, 518] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [432, 494] + "children": [451, 524] }, { "title": "Functions", - "kind": 64, - "children": [496] + "children": [526] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/index.ts#L1" } ] }, @@ -3689,8 +4484,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 13, - "character": 2 + "line": 14, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L14" } ], "signatures": [ @@ -3726,6 +4522,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 16, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L16" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -3769,6 +4573,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -3785,9 +4596,9 @@ "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { @@ -3800,9 +4611,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3811,14 +4622,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3848,7 +4659,7 @@ ] }, { - "id": 44, + "id": 47, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -3856,30 +4667,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 45, + "id": 48, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 46, + "id": 49, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -3887,7 +4719,7 @@ } }, { - "id": 47, + "id": 50, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3895,14 +4727,14 @@ "type": { "type": "reflection", "declaration": { - "id": 48, + "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 51, + "id": 54, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -3910,13 +4742,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -3937,7 +4775,7 @@ } }, { - "id": 50, + "id": 53, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -3945,13 +4783,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -3973,19 +4817,25 @@ } }, { - "id": 49, + "id": 52, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -3994,7 +4844,7 @@ } }, { - "id": 52, + "id": 55, "name": "type", "kind": 1024, "kindString": "Property", @@ -4002,18 +4852,36 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType" } } @@ -4021,8 +4889,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [51, 50, 49, 52] + "children": [54, 53, 52, 55] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -4039,14 +4914,14 @@ { "type": "reflection", "declaration": { - "id": 53, + "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 57, "name": "data", "kind": 1024, "kindString": "Property", @@ -4054,8 +4929,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -4063,7 +4939,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -4071,13 +4947,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 55, + "id": 58, "name": "error", "kind": 1024, "kindString": "Property", @@ -4085,8 +4961,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -4098,8 +4975,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54, 55] + "children": [57, 58] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -4107,14 +4991,14 @@ { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 57, + "id": 60, "name": "data", "kind": 1024, "kindString": "Property", @@ -4122,8 +5006,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -4132,7 +5017,7 @@ } }, { - "id": 58, + "id": 61, "name": "error", "kind": 1024, "kindString": "Property", @@ -4140,13 +5025,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4154,8 +5040,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [57, 58] + "children": [60, 61] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -4163,15 +5056,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 86, + "id": 89, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -4179,29 +5072,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 87, + "id": 90, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 88, + "id": 91, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -4218,14 +5130,14 @@ { "type": "reflection", "declaration": { - "id": 89, + "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 90, + "id": 93, "name": "data", "kind": 1024, "kindString": "Property", @@ -4233,21 +5145,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 94, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 95, "name": "message", "kind": 1024, "kindString": "Property", @@ -4255,8 +5168,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -4268,15 +5182,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [92] + "children": [95] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 93, + "id": 96, "name": "error", "kind": 1024, "kindString": "Property", @@ -4284,8 +5205,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -4297,8 +5219,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [90, 93] + "children": [93, 96] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -4306,14 +5235,14 @@ { "type": "reflection", "declaration": { - "id": 94, + "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 95, + "id": 98, "name": "data", "kind": 1024, "kindString": "Property", @@ -4321,8 +5250,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -4331,7 +5261,7 @@ } }, { - "id": 96, + "id": 99, "name": "error", "kind": 1024, "kindString": "Property", @@ -4339,13 +5269,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4353,8 +5284,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [95, 96] + "children": [98, 99] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -4362,15 +5300,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 75, + "id": 78, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -4378,29 +5316,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 76, + "id": 79, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 77, + "id": 80, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -4417,14 +5366,14 @@ { "type": "reflection", "declaration": { - "id": 78, + "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, + "id": 82, "name": "data", "kind": 1024, "kindString": "Property", @@ -4432,21 +5381,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 83, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 81, + "id": 84, "name": "message", "kind": 1024, "kindString": "Property", @@ -4454,8 +5404,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -4467,15 +5418,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [81] + "children": [84] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 82, + "id": 85, "name": "error", "kind": 1024, "kindString": "Property", @@ -4483,8 +5441,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -4496,8 +5455,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [79, 82] + "children": [82, 85] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -4505,14 +5471,14 @@ { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "data", "kind": 1024, "kindString": "Property", @@ -4520,8 +5486,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -4530,7 +5497,7 @@ } }, { - "id": 85, + "id": 88, "name": "error", "kind": 1024, "kindString": "Property", @@ -4538,13 +5505,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4552,8 +5520,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [84, 85] + "children": [87, 88] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -4561,15 +5536,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 35, + "id": 38, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -4577,29 +5552,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 36, + "id": 39, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 37, + "id": 40, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -4616,14 +5602,14 @@ { "type": "reflection", "declaration": { - "id": 38, + "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 39, + "id": 42, "name": "data", "kind": 1024, "kindString": "Property", @@ -4631,18 +5617,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 40, + "id": 43, "name": "error", "kind": 1024, "kindString": "Property", @@ -4650,8 +5637,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -4663,8 +5651,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [39, 40] + "children": [42, 43] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -4672,14 +5667,14 @@ { "type": "reflection", "declaration": { - "id": 41, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 42, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -4687,8 +5682,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -4697,7 +5693,7 @@ } }, { - "id": 43, + "id": 46, "name": "error", "kind": 1024, "kindString": "Property", @@ -4705,13 +5701,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4719,8 +5716,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [42, 43] + "children": [45, 46] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -4728,15 +5732,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 27, + "id": 30, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -4744,19 +5748,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 28, + "id": 31, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -4767,14 +5777,14 @@ { "type": "reflection", "declaration": { - "id": 29, + "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 30, + "id": 33, "name": "data", "kind": 1024, "kindString": "Property", @@ -4782,21 +5792,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 31, + "id": 34, "name": "error", "kind": 1024, "kindString": "Property", @@ -4804,8 +5815,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -4817,8 +5829,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [30, 31] + "children": [33, 34] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -4826,14 +5845,14 @@ { "type": "reflection", "declaration": { - "id": 32, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 33, + "id": 36, "name": "data", "kind": 1024, "kindString": "Property", @@ -4841,8 +5860,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -4851,7 +5871,7 @@ } }, { - "id": 34, + "id": 37, "name": "error", "kind": 1024, "kindString": "Property", @@ -4859,13 +5879,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4873,8 +5894,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [33, 34] + "children": [36, 37] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -4882,15 +5910,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" + } + } + ] + }, + { + "id": 28, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 29, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 3, + "name": "default" } } ] }, { - "id": 59, + "id": 62, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -4898,29 +5965,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 60, + "id": 63, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 61, + "id": 64, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -4928,7 +6006,7 @@ } }, { - "id": 62, + "id": 65, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -4936,14 +6014,14 @@ "type": { "type": "reflection", "declaration": { - "id": 63, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 66, + "id": 69, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -4951,13 +6029,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -4978,7 +6062,7 @@ } }, { - "id": 65, + "id": 68, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -4986,13 +6070,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -5014,19 +6104,25 @@ } }, { - "id": 64, + "id": 67, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -5038,8 +6134,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [66, 65, 64] + "children": [69, 68, 67] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -5055,14 +6158,14 @@ { "type": "reflection", "declaration": { - "id": 67, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 68, + "id": 71, "name": "data", "kind": 1024, "kindString": "Property", @@ -5070,21 +6173,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 69, + "id": 72, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 73, "name": "message", "kind": 1024, "kindString": "Property", @@ -5092,8 +6196,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -5105,15 +6210,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [70] + "children": [73] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 71, + "id": 74, "name": "error", "kind": 1024, "kindString": "Property", @@ -5121,8 +6233,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -5134,8 +6247,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [68, 71] + "children": [71, 74] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -5143,14 +6263,14 @@ { "type": "reflection", "declaration": { - "id": 72, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 73, + "id": 76, "name": "data", "kind": 1024, "kindString": "Property", @@ -5158,8 +6278,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -5168,7 +6289,7 @@ } }, { - "id": 74, + "id": 77, "name": "error", "kind": 1024, "kindString": "Property", @@ -5176,13 +6297,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5190,8 +6312,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [73, 74] + "children": [76, 77] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -5199,9 +6328,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5210,26 +6339,25 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [4] }, { "title": "Methods", - "kind": 2048, - "children": [44, 86, 75, 35, 27, 59] + "children": [47, 89, 78, 38, 30, 28, 62] } ], "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 8, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L8" } ], "extendedBy": [ { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" } ] @@ -5238,7 +6366,6 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [3] } ], @@ -5246,26 +6373,27 @@ { "fileName": "src/packages/StorageBucketApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L1" } ] }, { - "id": 97, + "id": 100, "name": "packages/StorageFileApi", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 98, + "id": 101, "name": "default", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 99, + "id": 102, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -5273,20 +6401,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 48, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L51" } ], "signatures": [ { - "id": 100, + "id": 103, "name": "new default", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 101, + "id": 104, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -5297,7 +6426,7 @@ } }, { - "id": 102, + "id": 105, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -5305,20 +6434,28 @@ "type": { "type": "reflection", "declaration": { - "id": 103, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 53, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L53" + } + ], "indexSignature": { - "id": 104, + "id": 107, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 105, + "id": 108, "name": "key", "kind": 32768, "flags": {}, @@ -5338,7 +6475,7 @@ "defaultValue": "{}" }, { - "id": 106, + "id": 109, "name": "bucketId", "kind": 32768, "kindString": "Parameter", @@ -5351,7 +6488,7 @@ } }, { - "id": 107, + "id": 110, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -5361,34 +6498,41 @@ "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 109, + "id": 112, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 110, + "id": 113, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 111, + "id": 114, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -5397,9 +6541,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -5408,14 +6552,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5425,14 +6569,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 213, + "id": 219, "name": "copy", "kind": 2048, "kindString": "Method", @@ -5440,29 +6584,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 355, - "character": 8 + "line": 378, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L378" } ], "signatures": [ { - "id": 214, + "id": 220, "name": "copy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Copies an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 215, + "id": 221, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -5470,13 +6633,26 @@ } }, { - "id": 216, + "id": 222, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-copy.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -5484,7 +6660,7 @@ } }, { - "id": 217, + "id": 223, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5492,11 +6668,16 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions" } } @@ -5510,14 +6691,14 @@ { "type": "reflection", "declaration": { - "id": 218, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 225, "name": "data", "kind": 1024, "kindString": "Property", @@ -5525,21 +6706,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 8 + "line": 384, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 221, + "id": 227, "name": "path", "kind": 1024, "kindString": "Property", @@ -5547,8 +6729,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 16 + "line": 384, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { @@ -5560,15 +6743,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [221] + "children": [227] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 384, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ] } } }, { - "id": 222, + "id": 228, "name": "error", "kind": 1024, "kindString": "Property", @@ -5576,8 +6766,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 362, - "character": 8 + "line": 385, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L385" } ], "type": { @@ -5589,8 +6780,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [219, 222] + "children": [225, 228] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L383" } ] } @@ -5598,14 +6796,14 @@ { "type": "reflection", "declaration": { - "id": 223, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 224, + "id": 230, "name": "data", "kind": 1024, "kindString": "Property", @@ -5613,8 +6811,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 365, - "character": 8 + "line": 388, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L388" } ], "type": { @@ -5623,7 +6822,7 @@ } }, { - "id": 225, + "id": 231, "name": "error", "kind": 1024, "kindString": "Property", @@ -5631,13 +6830,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 366, - "character": 8 + "line": 389, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L389" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5645,8 +6845,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [224, 225] + "children": [230, 231] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 387, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L387" } ] } @@ -5654,15 +6861,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 169, + "id": 175, "name": "createSignedUploadUrl", "kind": 2048, "kindString": "Method", @@ -5670,29 +6877,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 225, - "character": 8 + "line": 242, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L242" } ], "signatures": [ { - "id": 170, + "id": 176, "name": "createSignedUploadUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + "summary": [ + { + "kind": "text", + "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + } + ] }, "parameters": [ { - "id": 171, + "id": 177, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -5700,7 +6926,7 @@ } }, { - "id": 172, + "id": 178, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5710,26 +6936,32 @@ "type": { "type": "reflection", "declaration": { - "id": 173, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 180, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + "summary": [ + { + "kind": "text", + "text": "If set to true, allows the file to be overwritten if it already exists." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, - "character": 16 + "line": 244, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ], "type": { @@ -5741,8 +6973,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [174] + "children": [180] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 244, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ] } @@ -5758,14 +6997,14 @@ { "type": "reflection", "declaration": { - "id": 175, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 176, + "id": 182, "name": "data", "kind": 1024, "kindString": "Property", @@ -5773,21 +7012,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 8 + "line": 247, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { "type": "reflection", "declaration": { - "id": 177, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 180, + "id": 186, "name": "path", "kind": 1024, "kindString": "Property", @@ -5795,8 +7035,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 50 + "line": 247, + "character": 50, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -5805,7 +7046,7 @@ } }, { - "id": 178, + "id": 184, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -5813,8 +7054,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 16 + "line": 247, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -5823,7 +7065,7 @@ } }, { - "id": 179, + "id": 185, "name": "token", "kind": 1024, "kindString": "Property", @@ -5831,8 +7073,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 35 + "line": 247, + "character": 35, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -5844,15 +7087,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [180, 178, 179] + "children": [186, 184, 185] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 247, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ] } } }, { - "id": 181, + "id": 187, "name": "error", "kind": 1024, "kindString": "Property", @@ -5860,8 +7110,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 + "line": 248, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L248" } ], "type": { @@ -5873,8 +7124,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [176, 181] + "children": [182, 187] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 246, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L246" } ] } @@ -5882,14 +7140,14 @@ { "type": "reflection", "declaration": { - "id": 182, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 183, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -5897,8 +7155,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 234, - "character": 8 + "line": 251, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L251" } ], "type": { @@ -5907,7 +7166,7 @@ } }, { - "id": 184, + "id": 190, "name": "error", "kind": 1024, "kindString": "Property", @@ -5915,13 +7174,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 235, - "character": 8 + "line": 252, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L252" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5929,8 +7189,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [183, 184] + "children": [189, 190] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 250, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L250" } ] } @@ -5938,15 +7205,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 226, + "id": 232, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -5954,43 +7221,75 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 399, - "character": 8 + "line": 425, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L425" } ], "signatures": [ { - "id": 227, + "id": 233, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 228, + "id": 234, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." - }, - "type": { + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { "type": "intrinsic", "name": "string" } }, { - "id": 229, + "id": 235, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URL expires. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for a URL which is valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -5998,7 +7297,7 @@ } }, { - "id": 230, + "id": 236, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6008,14 +7307,14 @@ "type": { "type": "reflection", "declaration": { - "id": 231, + "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 232, + "id": 238, "name": "download", "kind": 1024, "kindString": "Property", @@ -6023,13 +7322,19 @@ "isOptional": true }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 16 + "line": 428, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { @@ -6047,7 +7352,7 @@ } }, { - "id": 233, + "id": 239, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6055,18 +7360,24 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 45 + "line": 428, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions" } } @@ -6074,8 +7385,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [232, 233] + "children": [238, 239] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 428, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ] } @@ -6091,14 +7409,14 @@ { "type": "reflection", "declaration": { - "id": 234, + "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 235, + "id": 241, "name": "data", "kind": 1024, "kindString": "Property", @@ -6106,21 +7424,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 8 + "line": 431, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 243, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -6128,8 +7447,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 16 + "line": 431, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { @@ -6141,15 +7461,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [243] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 431, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ] } } }, { - "id": 238, + "id": 244, "name": "error", "kind": 1024, "kindString": "Property", @@ -6157,8 +7484,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 406, - "character": 8 + "line": 432, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L432" } ], "type": { @@ -6170,8 +7498,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [235, 238] + "children": [241, 244] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 430, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L430" } ] } @@ -6179,14 +7514,14 @@ { "type": "reflection", "declaration": { - "id": 239, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 240, + "id": 246, "name": "data", "kind": 1024, "kindString": "Property", @@ -6194,8 +7529,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 409, - "character": 8 + "line": 435, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L435" } ], "type": { @@ -6204,7 +7540,7 @@ } }, { - "id": 241, + "id": 247, "name": "error", "kind": 1024, "kindString": "Property", @@ -6212,13 +7548,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 410, - "character": 8 + "line": 436, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L436" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6226,8 +7563,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [240, 241] + "children": [246, 247] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 434, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L434" } ] } @@ -6235,15 +7579,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 242, + "id": 248, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -6251,29 +7595,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 444, - "character": 8 + "line": 473, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L473" } ], "signatures": [ { - "id": 243, + "id": 249, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 244, + "id": 250, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." + "summary": [ + { + "kind": "text", + "text": "The file paths to be downloaded, including the current file names. For example " + }, + { + "kind": "code", + "text": "`['folder/image.png', 'folder2/image2.png']`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "array", @@ -6284,13 +7647,26 @@ } }, { - "id": 245, + "id": 251, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URLs expire. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for URLs which are valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -6298,7 +7674,7 @@ } }, { - "id": 246, + "id": 252, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6308,26 +7684,32 @@ "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 253, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 248, + "id": 254, "name": "download", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 447, - "character": 16 + "line": 476, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ], "type": { @@ -6348,8 +7730,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [248] + "children": [254] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 476, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ] } @@ -6365,14 +7754,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 256, "name": "data", "kind": 1024, "kindString": "Property", @@ -6380,8 +7769,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 8 + "line": 479, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6389,14 +7779,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 251, + "id": 257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 252, + "id": 258, "name": "error", "kind": 1024, "kindString": "Property", @@ -6404,8 +7794,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 16 + "line": 479, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6423,7 +7814,7 @@ } }, { - "id": 253, + "id": 259, "name": "path", "kind": 1024, "kindString": "Property", @@ -6431,8 +7822,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 38 + "line": 479, + "character": 38, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6450,7 +7842,7 @@ } }, { - "id": 254, + "id": 260, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -6458,8 +7850,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 59 + "line": 479, + "character": 59, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6471,8 +7864,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [252, 253, 254] + "children": [258, 259, 260] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ] } @@ -6480,7 +7880,7 @@ } }, { - "id": 255, + "id": 261, "name": "error", "kind": 1024, "kindString": "Property", @@ -6488,8 +7888,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 451, - "character": 8 + "line": 480, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L480" } ], "type": { @@ -6501,8 +7902,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [250, 255] + "children": [256, 261] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 478, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L478" } ] } @@ -6510,14 +7918,14 @@ { "type": "reflection", "declaration": { - "id": 256, + "id": 262, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 263, "name": "data", "kind": 1024, "kindString": "Property", @@ -6525,8 +7933,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 454, - "character": 8 + "line": 483, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L483" } ], "type": { @@ -6535,7 +7944,7 @@ } }, { - "id": 258, + "id": 264, "name": "error", "kind": 1024, "kindString": "Property", @@ -6543,13 +7952,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 455, - "character": 8 + "line": 484, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L484" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6557,8 +7967,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [257, 258] + "children": [263, 264] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 482, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L482" } ] } @@ -6566,15 +7983,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 259, + "id": 265, "name": "download", "kind": 2048, "kindString": "Method", @@ -6582,29 +7999,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 493, - "character": 8 + "line": 525, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L525" } ], "signatures": [ { - "id": 260, + "id": 266, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." + "summary": [ + { + "kind": "text", + "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " + }, + { + "kind": "code", + "text": "`getPublicUrl`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "parameters": [ { - "id": 261, + "id": 267, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The full path and file name of the file to be downloaded. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -6612,7 +8056,7 @@ } }, { - "id": 262, + "id": 268, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6622,14 +8066,14 @@ "type": { "type": "reflection", "declaration": { - "id": 263, + "id": 269, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 264, + "id": 270, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6637,18 +8081,24 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 495, - "character": 16 + "line": 527, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions" } } @@ -6656,8 +8106,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [264] + "children": [270] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 527, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ] } @@ -6673,14 +8130,14 @@ { "type": "reflection", "declaration": { - "id": 265, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 266, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -6688,19 +8145,20 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 498, - "character": 8 + "line": 530, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L530" } ], "type": { "type": "reference", + "name": "Blob", "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "package": "typescript" } }, { - "id": 267, + "id": 273, "name": "error", "kind": 1024, "kindString": "Property", @@ -6708,8 +8166,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 499, - "character": 8 + "line": 531, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L531" } ], "type": { @@ -6721,8 +8180,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [266, 267] + "children": [272, 273] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 529, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L529" } ] } @@ -6730,14 +8196,14 @@ { "type": "reflection", "declaration": { - "id": 268, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 275, "name": "data", "kind": 1024, "kindString": "Property", @@ -6745,8 +8211,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 502, - "character": 8 + "line": 534, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L534" } ], "type": { @@ -6755,7 +8222,7 @@ } }, { - "id": 270, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -6763,13 +8230,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 503, - "character": 8 + "line": 535, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L535" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6777,8 +8245,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [269, 270] + "children": [275, 276] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 533, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L533" } ] } @@ -6786,15 +8261,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 280, + "id": 286, "name": "exists", "kind": 2048, "kindString": "Method", @@ -6802,30 +8277,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 565, - "character": 8 + "line": 603, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L603" } ], "signatures": [ { - "id": 281, + "id": 287, "name": "exists", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Checks the existence of a file." + "summary": [ + { + "kind": "text", + "text": "Checks the existence of a file." + } + ] }, "parameters": [ { - "id": 282, + "id": 288, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -6841,14 +8319,14 @@ { "type": "reflection", "declaration": { - "id": 283, + "id": 289, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 290, "name": "data", "kind": 1024, "kindString": "Property", @@ -6856,8 +8334,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 569, - "character": 8 + "line": 607, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L607" } ], "type": { @@ -6866,7 +8345,7 @@ } }, { - "id": 285, + "id": 291, "name": "error", "kind": 1024, "kindString": "Property", @@ -6874,8 +8353,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 570, - "character": 8 + "line": 608, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L608" } ], "type": { @@ -6887,8 +8367,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [284, 285] + "children": [290, 291] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 606, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L606" } ] } @@ -6896,14 +8383,14 @@ { "type": "reflection", "declaration": { - "id": 286, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 293, "name": "data", "kind": 1024, "kindString": "Property", @@ -6911,8 +8398,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 573, - "character": 8 + "line": 611, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L611" } ], "type": { @@ -6921,7 +8409,7 @@ } }, { - "id": 288, + "id": 294, "name": "error", "kind": 1024, "kindString": "Property", @@ -6929,13 +8417,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 574, - "character": 8 + "line": 612, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L612" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6943,8 +8432,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [287, 288] + "children": [293, 294] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 610, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L610" } ] } @@ -6952,15 +8448,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 289, + "id": 295, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -6968,29 +8464,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 606, - "character": 2 + "line": 647, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L647" } ], "signatures": [ { - "id": 290, + "id": 296, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + "summary": [ + { + "kind": "text", + "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + } + ] }, "parameters": [ { - "id": 291, + "id": 297, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The path and name of the file to generate the public URL for. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -6998,7 +8513,7 @@ } }, { - "id": 292, + "id": 298, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7008,14 +8523,14 @@ "type": { "type": "reflection", "declaration": { - "id": 293, + "id": 299, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 294, + "id": 300, "name": "download", "kind": 1024, "kindString": "Property", @@ -7023,13 +8538,19 @@ "isOptional": true }, "comment": { - "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 16 + "line": 649, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { @@ -7047,7 +8568,7 @@ } }, { - "id": 295, + "id": 301, "name": "transform", "kind": 1024, "kindString": "Property", @@ -7055,18 +8576,24 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 45 + "line": 649, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions" } } @@ -7074,8 +8601,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [294, 295] + "children": [300, 301] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 649, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ] } @@ -7085,14 +8619,14 @@ "type": { "type": "reflection", "declaration": { - "id": 296, + "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 297, + "id": 303, "name": "data", "kind": 1024, "kindString": "Property", @@ -7100,21 +8634,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 7 + "line": 650, + "character": 7, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { "type": "reflection", "declaration": { - "id": 298, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 299, + "id": 305, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -7122,8 +8657,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 15 + "line": 650, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { @@ -7135,8 +8671,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [299] + "children": [305] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ] } @@ -7146,8 +8689,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [297] + "children": [303] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 5, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ] } @@ -7156,7 +8706,7 @@ ] }, { - "id": 271, + "id": 277, "name": "info", "kind": 2048, "kindString": "Method", @@ -7164,30 +8714,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 532, - "character": 8 + "line": 567, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L567" } ], "signatures": [ { - "id": 272, + "id": 278, "name": "info", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing file." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing file." + } + ] }, "parameters": [ { - "id": 273, + "id": 279, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -7203,14 +8756,14 @@ { "type": "reflection", "declaration": { - "id": 274, + "id": 280, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 281, "name": "data", "kind": 1024, "kindString": "Property", @@ -7218,17 +8771,18 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 536, - "character": 8 + "line": 571, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L571" } ], "type": { "type": "reference", - "id": 494, + "id": 524, "typeArguments": [ { "type": "reference", - "id": 453, + "id": 472, "name": "FileObjectV2" } ], @@ -7236,7 +8790,244 @@ } }, { - "id": 276, + "id": 282, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 572, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L572" + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [281, 282] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 570, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L570" + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 283, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 284, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 575, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L575" + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 285, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 576, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L576" + } + ], + "type": { + "type": "reference", + "id": 529, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [284, 285] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 574, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L574" + } + ] + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 315, + "name": "list", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 785, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L785" + } + ], + "signatures": [ + { + "id": 316, + "name": "list", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Lists all the files and folders within a path of the bucket." + } + ] + }, + "parameters": [ + { + "id": 317, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The folder path." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 318, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search options including limit (defaults to 100), offset, sortBy, and search" + } + ] + }, + "type": { + "type": "reference", + "id": 498, + "name": "SearchOptions" + } + }, + { + "id": 319, + "name": "parameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 514, + "name": "FetchParameters" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 320, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 321, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 791, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L791" + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 462, + "name": "FileObject" + } + } + }, + { + "id": 322, "name": "error", "kind": 1024, "kindString": "Property", @@ -7244,8 +9035,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 537, - "character": 8 + "line": 792, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L792" } ], "type": { @@ -7257,8 +9049,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [275, 276] + "children": [321, 322] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 790, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L790" } ] } @@ -7266,14 +9065,14 @@ { "type": "reflection", "declaration": { - "id": 277, + "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 278, + "id": 324, "name": "data", "kind": 1024, "kindString": "Property", @@ -7281,8 +9080,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 540, - "character": 8 + "line": 795, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L795" } ], "type": { @@ -7291,7 +9091,7 @@ } }, { - "id": 279, + "id": 325, "name": "error", "kind": 1024, "kindString": "Property", @@ -7299,13 +9099,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 541, - "character": 8 + "line": 796, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L796" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7313,8 +9114,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [278, 279] + "children": [324, 325] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 794, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L794" } ] } @@ -7322,55 +9130,46 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 309, - "name": "list", + "id": 326, + "name": "listV2", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 741, - "character": 8 + "line": 826, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L826" } ], "signatures": [ { - "id": 310, - "name": "list", + "id": 327, + "name": "listV2", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all the files within a bucket." + "summary": [ + { + "kind": "text", + "text": "this method signature might change in the future" + } + ], + "modifierTags": ["@experimental"] }, "parameters": [ { - "id": 311, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The folder path." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 312, + "id": 328, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7378,16 +9177,21 @@ "isOptional": true }, "comment": { - "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search\n" + "summary": [ + { + "kind": "text", + "text": "search options" + } + ] }, "type": { "type": "reference", - "id": 479, - "name": "SearchOptions" + "id": 503, + "name": "SearchV2Options" } }, { - "id": 313, + "id": 329, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -7396,7 +9200,7 @@ }, "type": { "type": "reference", - "id": 484, + "id": 514, "name": "FetchParameters" } } @@ -7410,14 +9214,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 331, "name": "data", "kind": 1024, "kindString": "Property", @@ -7425,21 +9229,19 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 747, - "character": 8 + "line": 831, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L831" } ], "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 443, - "name": "FileObject" - } + "type": "reference", + "id": 508, + "name": "SearchV2Result" } }, { - "id": 316, + "id": 332, "name": "error", "kind": 1024, "kindString": "Property", @@ -7447,8 +9249,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 748, - "character": 8 + "line": 832, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L832" } ], "type": { @@ -7460,8 +9263,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [315, 316] + "children": [331, 332] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 830, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L830" } ] } @@ -7469,14 +9279,14 @@ { "type": "reflection", "declaration": { - "id": 317, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 318, + "id": 334, "name": "data", "kind": 1024, "kindString": "Property", @@ -7484,8 +9294,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 751, - "character": 8 + "line": 835, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L835" } ], "type": { @@ -7494,7 +9305,7 @@ } }, { - "id": 319, + "id": 335, "name": "error", "kind": 1024, "kindString": "Property", @@ -7502,13 +9313,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 752, - "character": 8 + "line": 836, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L836" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7516,8 +9328,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [318, 319] + "children": [334, 335] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 834, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L834" } ] } @@ -7525,15 +9344,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 200, + "id": 206, "name": "move", "kind": 2048, "kindString": "Method", @@ -7541,29 +9360,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, - "character": 8 + "line": 332, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L332" } ], "signatures": [ { - "id": 201, + "id": 207, "name": "move", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Moves an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 202, + "id": 208, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -7571,13 +9409,26 @@ } }, { - "id": 203, + "id": 209, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-new.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -7585,7 +9436,7 @@ } }, { - "id": 204, + "id": 210, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7593,11 +9444,16 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions" } } @@ -7611,14 +9467,14 @@ { "type": "reflection", "declaration": { - "id": 205, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 206, + "id": 212, "name": "data", "kind": 1024, "kindString": "Property", @@ -7626,21 +9482,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 8 + "line": 338, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 208, + "id": 214, "name": "message", "kind": 1024, "kindString": "Property", @@ -7648,8 +9505,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 16 + "line": 338, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { @@ -7661,15 +9519,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [208] + "children": [214] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 338, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ] } } }, { - "id": 209, + "id": 215, "name": "error", "kind": 1024, "kindString": "Property", @@ -7677,8 +9542,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 319, - "character": 8 + "line": 339, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L339" } ], "type": { @@ -7690,8 +9556,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [206, 209] + "children": [212, 215] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 337, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L337" } ] } @@ -7699,14 +9572,14 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 217, "name": "data", "kind": 1024, "kindString": "Property", @@ -7714,8 +9587,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 322, - "character": 8 + "line": 342, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L342" } ], "type": { @@ -7724,7 +9598,7 @@ } }, { - "id": 212, + "id": 218, "name": "error", "kind": 1024, "kindString": "Property", @@ -7732,13 +9606,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 323, - "character": 8 + "line": 343, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L343" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7746,8 +9621,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [211, 212] + "children": [217, 218] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 341, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L341" } ] } @@ -7755,15 +9637,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 300, + "id": 306, "name": "remove", "kind": 2048, "kindString": "Method", @@ -7771,29 +9653,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 644, - "character": 8 + "line": 685, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L685" } ], "signatures": [ { - "id": 301, + "id": 307, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes files within the same bucket" + "summary": [ + { + "kind": "text", + "text": "Deletes files within the same bucket" + } + ] }, "parameters": [ { - "id": 302, + "id": 308, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" + "summary": [ + { + "kind": "text", + "text": "An array of files to delete, including the path and file name. For example [" + }, + { + "kind": "code", + "text": "`'folder/image.png'`" + }, + { + "kind": "text", + "text": "]." + } + ] }, "type": { "type": "array", @@ -7813,14 +9714,14 @@ { "type": "reflection", "declaration": { - "id": 303, + "id": 309, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 304, + "id": 310, "name": "data", "kind": 1024, "kindString": "Property", @@ -7828,21 +9729,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 648, - "character": 8 + "line": 689, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L689" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 443, + "id": 462, "name": "FileObject" } } }, { - "id": 305, + "id": 311, "name": "error", "kind": 1024, "kindString": "Property", @@ -7850,8 +9752,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 649, - "character": 8 + "line": 690, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L690" } ], "type": { @@ -7863,8 +9766,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [304, 305] + "children": [310, 311] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 688, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L688" } ] } @@ -7872,14 +9782,14 @@ { "type": "reflection", "declaration": { - "id": 306, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 307, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -7887,8 +9797,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 652, - "character": 8 + "line": 693, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L693" } ], "type": { @@ -7897,7 +9808,7 @@ } }, { - "id": 308, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -7905,13 +9816,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, - "character": 8 + "line": 694, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L694" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7919,8 +9831,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [307, 308] + "children": [313, 314] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 692, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L692" } ] } @@ -7928,15 +9847,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" + } + } + ] + }, + { + "id": 127, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 66, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L66" + } + ], + "signatures": [ + { + "id": 128, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 101, + "name": "default" } } ] }, { - "id": 323, + "id": 339, "name": "toBase64", "kind": 2048, "kindString": "Method", @@ -7944,20 +9902,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 778, - "character": 2 + "line": 865, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L865" } ], "signatures": [ { - "id": 324, + "id": 340, "name": "toBase64", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 325, + "id": 341, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -7976,7 +9935,7 @@ ] }, { - "id": 185, + "id": 191, "name": "update", "kind": 2048, "kindString": "Method", @@ -7984,29 +9943,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 278, - "character": 8 + "line": 298, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L298" } ], "signatures": [ { - "id": 186, + "id": 192, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." + "summary": [ + { + "kind": "text", + "text": "Replaces an existing file at the specified path with a new one." + } + ] }, "parameters": [ { - "id": 187, + "id": 193, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." + "summary": [ + { + "kind": "text", + "text": "The relative file path. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to update." + } + ] }, "type": { "type": "intrinsic", @@ -8014,13 +9992,18 @@ } }, { - "id": 188, + "id": 194, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "union", @@ -8031,71 +10014,71 @@ }, { "type": "reference", + "name": "ArrayBuffer", "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" + "package": "typescript" }, { "type": "reference", + "name": "ArrayBufferView", "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" + "package": "typescript" }, { "type": "reference", + "name": "Blob", "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "package": "typescript" }, { "type": "reference", + "name": "Buffer", "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" + "package": "@types/node" }, { "type": "reference", + "name": "File", "qualifiedName": "File", - "package": "typescript", - "name": "File" + "package": "typescript" }, { "type": "reference", + "name": "FormData", "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" + "package": "typescript" }, { "type": "reference", + "name": "ReadableStream", "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" + "package": "@types/node" }, { "type": "reference", "typeArguments": [ { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } ], + "name": "ReadableStream", "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" + "package": "typescript" }, { "type": "reference", + "name": "URLSearchParams", "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" + "package": "typescript" } ] } }, { - "id": 189, + "id": 195, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -8104,7 +10087,7 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions" } } @@ -8118,14 +10101,14 @@ { "type": "reflection", "declaration": { - "id": 190, + "id": 196, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 191, + "id": 197, "name": "data", "kind": 1024, "kindString": "Property", @@ -8133,21 +10116,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 8 + "line": 314, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { "type": "reflection", "declaration": { - "id": 192, + "id": 198, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 201, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -8155,8 +10139,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 42 + "line": 314, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -8165,7 +10150,7 @@ } }, { - "id": 193, + "id": 199, "name": "id", "kind": 1024, "kindString": "Property", @@ -8173,8 +10158,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 16 + "line": 314, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -8183,7 +10169,7 @@ } }, { - "id": 194, + "id": 200, "name": "path", "kind": 1024, "kindString": "Property", @@ -8191,8 +10177,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 28 + "line": 314, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -8204,15 +10191,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [195, 193, 194] + "children": [201, 199, 200] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 314, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ] } } }, { - "id": 196, + "id": 202, "name": "error", "kind": 1024, "kindString": "Property", @@ -8220,8 +10214,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 295, - "character": 8 + "line": 315, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L315" } ], "type": { @@ -8233,8 +10228,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [191, 196] + "children": [197, 202] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 313, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L313" } ] } @@ -8242,14 +10244,14 @@ { "type": "reflection", "declaration": { - "id": 197, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -8257,8 +10259,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 298, - "character": 8 + "line": 318, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L318" } ], "type": { @@ -8267,7 +10270,7 @@ } }, { - "id": 199, + "id": 205, "name": "error", "kind": 1024, "kindString": "Property", @@ -8275,13 +10278,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 299, - "character": 8 + "line": 319, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L319" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8289,8 +10293,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [198, 199] + "children": [204, 205] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L317" } ] } @@ -8298,15 +10309,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 139, + "id": 145, "name": "upload", "kind": 2048, "kindString": "Method", @@ -8314,29 +10325,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 147, - "character": 8 + "line": 161, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L161" } ], "signatures": [ { - "id": 140, + "id": 146, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Uploads a file to an existing bucket." + "summary": [ + { + "kind": "text", + "text": "Uploads a file to an existing bucket." + } + ] }, "parameters": [ { - "id": 141, + "id": 147, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -8344,13 +10374,18 @@ } }, { - "id": 142, + "id": 148, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -8358,7 +10393,7 @@ } }, { - "id": 143, + "id": 149, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -8367,7 +10402,7 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions" } } @@ -8381,14 +10416,14 @@ { "type": "reflection", "declaration": { - "id": 144, + "id": 150, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 145, + "id": 151, "name": "data", "kind": 1024, "kindString": "Property", @@ -8396,21 +10431,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 8 + "line": 167, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { "type": "reflection", "declaration": { - "id": 146, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 149, + "id": 155, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -8418,8 +10454,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 42 + "line": 167, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -8428,7 +10465,7 @@ } }, { - "id": 147, + "id": 153, "name": "id", "kind": 1024, "kindString": "Property", @@ -8436,8 +10473,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 16 + "line": 167, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -8446,7 +10484,7 @@ } }, { - "id": 148, + "id": 154, "name": "path", "kind": 1024, "kindString": "Property", @@ -8454,8 +10492,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 28 + "line": 167, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -8467,15 +10506,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [149, 147, 148] + "children": [155, 153, 154] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 167, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ] } } }, { - "id": 150, + "id": 156, "name": "error", "kind": 1024, "kindString": "Property", @@ -8483,8 +10529,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 154, - "character": 8 + "line": 168, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L168" } ], "type": { @@ -8496,8 +10543,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [145, 150] + "children": [151, 156] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 166, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L166" } ] } @@ -8505,14 +10559,14 @@ { "type": "reflection", "declaration": { - "id": 151, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 158, "name": "data", "kind": 1024, "kindString": "Property", @@ -8520,8 +10574,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 157, - "character": 8 + "line": 171, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L171" } ], "type": { @@ -8530,7 +10585,7 @@ } }, { - "id": 153, + "id": 159, "name": "error", "kind": 1024, "kindString": "Property", @@ -8538,13 +10593,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, - "character": 8 + "line": 172, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L172" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8552,8 +10608,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152, 153] + "children": [158, 159] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 170, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L170" } ] } @@ -8561,15 +10624,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 154, + "id": 160, "name": "uploadToSignedUrl", "kind": 2048, "kindString": "Method", @@ -8577,29 +10640,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 170, - "character": 8 + "line": 184, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L184" } ], "signatures": [ { - "id": 155, + "id": 161, "name": "uploadToSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." + "summary": [ + { + "kind": "text", + "text": "Upload a file with a token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 156, + "id": 162, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -8607,13 +10697,22 @@ } }, { - "id": 157, + "id": 163, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The token generated from `createSignedUploadUrl`" + "summary": [ + { + "kind": "text", + "text": "The token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + } + ] }, "type": { "type": "intrinsic", @@ -8621,13 +10720,18 @@ } }, { - "id": 158, + "id": 164, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -8635,7 +10739,7 @@ } }, { - "id": 159, + "id": 165, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -8644,7 +10748,7 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions" } } @@ -8658,14 +10762,14 @@ { "type": "reflection", "declaration": { - "id": 160, + "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 161, + "id": 167, "name": "data", "kind": 1024, "kindString": "Property", @@ -8673,21 +10777,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 8 + "line": 220, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { "type": "reflection", "declaration": { - "id": 162, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 164, + "id": 170, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -8695,8 +10800,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 33 + "line": 220, + "character": 33, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -8706,7 +10812,7 @@ "defaultValue": "data.Key" }, { - "id": 163, + "id": 169, "name": "path", "kind": 1024, "kindString": "Property", @@ -8714,8 +10820,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 16 + "line": 220, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -8728,8 +10835,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [164, 163] + "children": [170, 169] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 220, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ] } @@ -8737,7 +10851,7 @@ "defaultValue": "..." }, { - "id": 165, + "id": 171, "name": "error", "kind": 1024, "kindString": "Property", @@ -8745,8 +10859,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 207, - "character": 8 + "line": 221, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L221" } ], "type": { @@ -8759,8 +10874,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [161, 165] + "children": [167, 171] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 219, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L219" } ] } @@ -8768,14 +10890,14 @@ { "type": "reflection", "declaration": { - "id": 166, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 167, + "id": 173, "name": "data", "kind": 1024, "kindString": "Property", @@ -8783,8 +10905,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 211, - "character": 17 + "line": 228, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ], "type": { @@ -8794,14 +10917,22 @@ "defaultValue": "null" }, { - "id": 168, + "id": 174, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 29, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" + } + ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8809,8 +10940,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [167, 168] + "children": [173, 174] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ] } @@ -8818,9 +10956,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -8829,22 +10967,21 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [99] + "children": [102] }, { "title": "Methods", - "kind": 2048, "children": [ - 213, 169, 226, 242, 259, 280, 289, 271, 309, 200, 300, 323, 185, 139, 154 + 219, 175, 232, 248, 265, 286, 295, 277, 315, 326, 206, 306, 127, 339, 191, 145, 160 ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 42, - "character": 21 + "line": 44, + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L44" } ] } @@ -8852,15 +10989,15 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [98] + "children": [101] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L1" } ] } @@ -8868,8 +11005,7 @@ "groups": [ { "title": "Modules", - "kind": 2, - "children": [1, 2, 97] + "children": [1, 2, 100] } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json index 568bb753b215e..ffea6014c4f74 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json @@ -13,14 +13,14 @@ "flags": {}, "children": [ { - "id": 504, + "id": 534, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 505, + "id": 535, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -29,19 +29,20 @@ { "fileName": "src/lib/errors.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L18" } ], "signatures": [ { - "id": 506, + "id": 536, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 537, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52,7 +53,7 @@ } }, { - "id": 508, + "id": 538, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -63,7 +64,7 @@ } }, { - "id": 509, + "id": 539, "name": "statusCode", "kind": 32768, "kindString": "Parameter", @@ -76,24 +77,24 @@ ], "type": { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 510, + "id": 540, "name": "status", "kind": 1024, "kindString": "Property", @@ -102,7 +103,8 @@ { "fileName": "src/lib/errors.ts", "line": 15, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L15" } ], "type": { @@ -111,7 +113,7 @@ } }, { - "id": 511, + "id": 541, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -120,7 +122,8 @@ { "fileName": "src/lib/errors.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L16" } ], "type": { @@ -129,7 +132,7 @@ } }, { - "id": 512, + "id": 542, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -138,12 +141,13 @@ { "fileName": "src/lib/errors.ts", "line": 25, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L25" } ], "signatures": [ { - "id": 513, + "id": 543, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -151,14 +155,14 @@ "type": { "type": "reflection", "declaration": { - "id": 514, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 546, "name": "message", "kind": 1024, "kindString": "Property", @@ -167,7 +171,8 @@ { "fileName": "src/lib/errors.ts", "line": 28, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L28" } ], "type": { @@ -177,7 +182,7 @@ "defaultValue": "..." }, { - "id": 515, + "id": 545, "name": "name", "kind": 1024, "kindString": "Property", @@ -186,7 +191,8 @@ { "fileName": "src/lib/errors.ts", "line": 27, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L27" } ], "type": { @@ -196,7 +202,7 @@ "defaultValue": "..." }, { - "id": 517, + "id": 547, "name": "status", "kind": 1024, "kindString": "Property", @@ -205,7 +211,8 @@ { "fileName": "src/lib/errors.ts", "line": 29, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L29" } ], "type": { @@ -215,7 +222,7 @@ "defaultValue": "..." }, { - "id": 518, + "id": 548, "name": "statusCode", "kind": 1024, "kindString": "Property", @@ -224,7 +231,8 @@ { "fileName": "src/lib/errors.ts", "line": 30, - "character": 6 + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L30" } ], "type": { @@ -237,8 +245,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [516, 515, 517, 518] + "children": [546, 545, 547, 548] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L26" } ] } @@ -250,44 +265,42 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [505] + "children": [535] }, { "title": "Properties", - "kind": 1024, - "children": [510, 511] + "children": [540, 541] }, { "title": "Methods", - "kind": 2048, - "children": [512] + "children": [542] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 14, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L14" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 335, + "id": 351, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 336, + "id": 352, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -296,19 +309,20 @@ { "fileName": "src/StorageClient.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L10" } ], "signatures": [ { - "id": 337, + "id": 353, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 338, + "id": 354, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -319,7 +333,7 @@ } }, { - "id": 339, + "id": 355, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -327,20 +341,28 @@ "type": { "type": "reflection", "declaration": { - "id": 340, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 12, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L12" + } + ], "indexSignature": { - "id": 341, + "id": 357, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 342, + "id": 358, "name": "key", "kind": 32768, "flags": {}, @@ -360,7 +382,7 @@ "defaultValue": "{}" }, { - "id": 343, + "id": 359, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -370,34 +392,41 @@ "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 345, + "id": 361, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 346, + "id": 362, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 347, + "id": 363, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -406,9 +435,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -417,14 +446,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -432,7 +461,7 @@ } }, { - "id": 348, + "id": 364, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -447,7 +476,7 @@ ], "type": { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" }, "overwrites": { @@ -464,7 +493,7 @@ } }, { - "id": 379, + "id": 398, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -472,30 +501,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 380, + "id": 399, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 381, + "id": 400, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -503,7 +553,7 @@ } }, { - "id": 382, + "id": 401, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -511,14 +561,14 @@ "type": { "type": "reflection", "declaration": { - "id": 383, + "id": 402, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 405, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -526,13 +576,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -553,7 +609,7 @@ } }, { - "id": 385, + "id": 404, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -561,13 +617,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -589,19 +651,25 @@ } }, { - "id": 384, + "id": 403, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -610,7 +678,7 @@ } }, { - "id": 387, + "id": 406, "name": "type", "kind": 1024, "kindString": "Property", @@ -618,21 +686,39 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -641,7 +727,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -664,8 +751,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [386, 385, 384, 387] + "children": [405, 404, 403, 406] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -682,14 +776,14 @@ { "type": "reflection", "declaration": { - "id": 388, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 408, "name": "data", "kind": 1024, "kindString": "Property", @@ -697,8 +791,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -706,7 +801,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -714,13 +809,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 390, + "id": 409, "name": "error", "kind": 1024, "kindString": "Property", @@ -728,8 +823,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -741,8 +837,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [389, 390] + "children": [408, 409] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -750,14 +853,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 411, "name": "data", "kind": 1024, "kindString": "Property", @@ -765,8 +868,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -775,7 +879,7 @@ } }, { - "id": 393, + "id": 412, "name": "error", "kind": 1024, "kindString": "Property", @@ -783,13 +887,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -797,8 +902,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [392, 393] + "children": [411, 412] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -806,25 +918,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 48, "name": "default.createBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 44, + "id": 47, "name": "default.createBucket" } }, { - "id": 421, + "id": 440, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -832,29 +944,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 422, + "id": 441, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 423, + "id": 442, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -871,14 +1002,14 @@ { "type": "reflection", "declaration": { - "id": 424, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 425, + "id": 444, "name": "data", "kind": 1024, "kindString": "Property", @@ -886,21 +1017,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 445, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 446, "name": "message", "kind": 1024, "kindString": "Property", @@ -908,8 +1040,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -921,15 +1054,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [427] + "children": [446] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 428, + "id": 447, "name": "error", "kind": 1024, "kindString": "Property", @@ -937,8 +1077,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -950,8 +1091,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [425, 428] + "children": [444, 447] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -959,14 +1107,14 @@ { "type": "reflection", "declaration": { - "id": 429, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 430, + "id": 449, "name": "data", "kind": 1024, "kindString": "Property", @@ -974,8 +1122,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -984,7 +1133,7 @@ } }, { - "id": 431, + "id": 450, "name": "error", "kind": 1024, "kindString": "Property", @@ -992,13 +1141,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1006,8 +1156,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [430, 431] + "children": [449, 450] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -1015,25 +1172,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 87, + "id": 90, "name": "default.deleteBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 86, + "id": 89, "name": "default.deleteBucket" } }, { - "id": 410, + "id": 429, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -1041,29 +1198,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 411, + "id": 430, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 412, + "id": 431, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -1080,14 +1248,14 @@ { "type": "reflection", "declaration": { - "id": 413, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 414, + "id": 433, "name": "data", "kind": 1024, "kindString": "Property", @@ -1095,21 +1263,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 434, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 435, "name": "message", "kind": 1024, "kindString": "Property", @@ -1117,8 +1286,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -1130,15 +1300,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [416] + "children": [435] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 417, + "id": 436, "name": "error", "kind": 1024, "kindString": "Property", @@ -1146,8 +1323,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -1159,8 +1337,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [414, 417] + "children": [433, 436] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -1168,14 +1353,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 437, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 438, "name": "data", "kind": 1024, "kindString": "Property", @@ -1183,8 +1368,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -1193,7 +1379,7 @@ } }, { - "id": 420, + "id": 439, "name": "error", "kind": 1024, "kindString": "Property", @@ -1201,13 +1387,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1215,8 +1402,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [419, 420] + "children": [438, 439] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -1224,25 +1418,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 76, + "id": 79, "name": "default.emptyBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 75, + "id": 78, "name": "default.emptyBucket" } }, { - "id": 349, + "id": 365, "name": "from", "kind": 2048, "kindString": "Method", @@ -1251,28 +1445,39 @@ { "fileName": "src/StorageClient.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L24" } ], "signatures": [ { - "id": 350, + "id": 366, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform file operation in a bucket." + "summary": [ + { + "kind": "text", + "text": "Perform file operation in a bucket." + } + ] }, "parameters": [ { - "id": 351, + "id": 367, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The bucket id to operate on.\n" + "summary": [ + { + "kind": "text", + "text": "The bucket id to operate on." + } + ] }, "type": { "type": "intrinsic", @@ -1282,14 +1487,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 370, + "id": 389, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -1297,29 +1502,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 371, + "id": 390, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 372, + "id": 391, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -1336,14 +1552,14 @@ { "type": "reflection", "declaration": { - "id": 373, + "id": 392, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 374, + "id": 393, "name": "data", "kind": 1024, "kindString": "Property", @@ -1351,18 +1567,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 375, + "id": 394, "name": "error", "kind": 1024, "kindString": "Property", @@ -1370,8 +1587,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -1383,8 +1601,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [374, 375] + "children": [393, 394] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -1392,14 +1617,14 @@ { "type": "reflection", "declaration": { - "id": 376, + "id": 395, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 377, + "id": 396, "name": "data", "kind": 1024, "kindString": "Property", @@ -1407,8 +1632,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -1417,7 +1643,7 @@ } }, { - "id": 378, + "id": 397, "name": "error", "kind": 1024, "kindString": "Property", @@ -1425,13 +1651,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1439,8 +1666,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [377, 378] + "children": [396, 397] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -1448,25 +1682,25 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 36, + "id": 39, "name": "default.getBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 35, + "id": 38, "name": "default.getBucket" } }, { - "id": 362, + "id": 381, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -1474,19 +1708,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 363, + "id": 382, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -1497,14 +1737,14 @@ { "type": "reflection", "declaration": { - "id": 364, + "id": 383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 365, + "id": 384, "name": "data", "kind": 1024, "kindString": "Property", @@ -1512,21 +1752,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 366, + "id": 385, "name": "error", "kind": 1024, "kindString": "Property", @@ -1534,8 +1775,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -1547,8 +1789,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [365, 366] + "children": [384, 385] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -1556,14 +1805,14 @@ { "type": "reflection", "declaration": { - "id": 367, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 387, "name": "data", "kind": 1024, "kindString": "Property", @@ -1571,8 +1820,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -1581,7 +1831,7 @@ } }, { - "id": 369, + "id": 388, "name": "error", "kind": 1024, "kindString": "Property", @@ -1589,13 +1839,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1603,8 +1854,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [368, 369] + "children": [387, 388] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -1612,25 +1870,74 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 28, + "id": 31, "name": "default.listBuckets" } } ], "inheritedFrom": { "type": "reference", - "id": 27, + "id": 30, "name": "default.listBuckets" } }, { - "id": 394, + "id": 379, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 380, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 351, + "name": "StorageClient" + }, + "inheritedFrom": { + "type": "reference", + "id": 29, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 28, + "name": "default.throwOnError" + } + }, + { + "id": 413, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -1638,29 +1945,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 395, + "id": 414, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 396, + "id": 415, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -1668,7 +1986,7 @@ } }, { - "id": 397, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1676,14 +1994,14 @@ "type": { "type": "reflection", "declaration": { - "id": 398, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 401, + "id": 420, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -1691,13 +2009,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -1718,7 +2042,7 @@ } }, { - "id": 400, + "id": 419, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -1726,13 +2050,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -1754,19 +2084,25 @@ } }, { - "id": 399, + "id": 418, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -1778,8 +2114,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [401, 400, 399] + "children": [420, 419, 418] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -1795,14 +2138,14 @@ { "type": "reflection", "declaration": { - "id": 402, + "id": 421, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 403, + "id": 422, "name": "data", "kind": 1024, "kindString": "Property", @@ -1810,21 +2153,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 404, + "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 405, + "id": 424, "name": "message", "kind": 1024, "kindString": "Property", @@ -1832,8 +2176,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -1845,15 +2190,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [405] + "children": [424] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 406, + "id": 425, "name": "error", "kind": 1024, "kindString": "Property", @@ -1861,8 +2213,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -1874,8 +2227,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [403, 406] + "children": [422, 425] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -1883,14 +2243,14 @@ { "type": "reflection", "declaration": { - "id": 407, + "id": 426, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 408, + "id": 427, "name": "data", "kind": 1024, "kindString": "Property", @@ -1898,8 +2258,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -1908,7 +2269,7 @@ } }, { - "id": 409, + "id": 428, "name": "error", "kind": 1024, "kindString": "Property", @@ -1916,13 +2277,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -1930,8 +2292,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [408, 409] + "children": [427, 428] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -1939,20 +2308,20 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "id": 60, + "id": 63, "name": "default.updateBucket" } } ], "inheritedFrom": { "type": "reference", - "id": 59, + "id": 62, "name": "default.updateBucket" } } @@ -1960,20 +2329,19 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [336] + "children": [352] }, { "title": "Methods", - "kind": 2048, - "children": [379, 421, 410, 349, 370, 362, 394] + "children": [398, 440, 429, 365, 389, 381, 379, 413] } ], "sources": [ { "fileName": "src/StorageClient.ts", "line": 9, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/StorageClient.ts#L9" } ], "extendedTypes": [ @@ -1985,14 +2353,14 @@ ] }, { - "id": 499, + "id": 529, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 500, + "id": 530, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2001,19 +2369,20 @@ { "fileName": "src/lib/errors.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L4" } ], "signatures": [ { - "id": 501, + "id": 531, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 502, + "id": 532, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2026,7 +2395,7 @@ ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" }, "overwrites": { @@ -2044,47 +2413,47 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [500] + "children": [530] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 1, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L1" } ], "extendedTypes": [ { "type": "reference", + "name": "Error", "qualifiedName": "Error", - "package": "typescript", - "name": "Error" + "package": "typescript" } ], "extendedBy": [ { "type": "reference", - "id": 504, + "id": 534, "name": "StorageApiError" }, { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" } ] }, { - "id": 520, + "id": 550, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 521, + "id": 551, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2093,19 +2462,20 @@ { "fileName": "src/lib/errors.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L38" } ], "signatures": [ { - "id": 522, + "id": 552, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 523, + "id": 553, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2116,7 +2486,7 @@ } }, { - "id": 524, + "id": 554, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2129,24 +2499,24 @@ ], "type": { "type": "reference", - "id": 520, + "id": 550, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 501, + "id": 531, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 500, + "id": 530, "name": "StorageError.constructor" } }, { - "id": 525, + "id": 555, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2155,7 +2525,8 @@ { "fileName": "src/lib/errors.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L36" } ], "type": { @@ -2167,39 +2538,38 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [521] + "children": [551] }, { "title": "Properties", - "kind": 1024, - "children": [525] + "children": [555] } ], "sources": [ { "fileName": "src/lib/errors.ts", "line": 35, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L35" } ], "extendedTypes": [ { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } ] }, { - "id": 433, + "id": 452, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 439, + "id": 458, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2210,7 +2580,8 @@ { "fileName": "src/lib/types.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L9" } ], "type": { @@ -2222,7 +2593,7 @@ } }, { - "id": 440, + "id": 459, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2231,7 +2602,8 @@ { "fileName": "src/lib/types.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L10" } ], "type": { @@ -2240,7 +2612,7 @@ } }, { - "id": 438, + "id": 457, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2251,7 +2623,8 @@ { "fileName": "src/lib/types.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L8" } ], "type": { @@ -2260,7 +2633,7 @@ } }, { - "id": 434, + "id": 453, "name": "id", "kind": 1024, "kindString": "Property", @@ -2269,7 +2642,8 @@ { "fileName": "src/lib/types.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L4" } ], "type": { @@ -2278,7 +2652,7 @@ } }, { - "id": 436, + "id": 455, "name": "name", "kind": 1024, "kindString": "Property", @@ -2287,7 +2661,8 @@ { "fileName": "src/lib/types.ts", "line": 6, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L6" } ], "type": { @@ -2296,7 +2671,7 @@ } }, { - "id": 437, + "id": 456, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2305,7 +2680,8 @@ { "fileName": "src/lib/types.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L7" } ], "type": { @@ -2314,7 +2690,7 @@ } }, { - "id": 442, + "id": 461, "name": "public", "kind": 1024, "kindString": "Property", @@ -2323,7 +2699,8 @@ { "fileName": "src/lib/types.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L12" } ], "type": { @@ -2332,7 +2709,7 @@ } }, { - "id": 435, + "id": 454, "name": "type", "kind": 1024, "kindString": "Property", @@ -2343,15 +2720,16 @@ { "fileName": "src/lib/types.ts", "line": 5, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L5" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -2360,7 +2738,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -2380,7 +2759,7 @@ } }, { - "id": 441, + "id": 460, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2389,7 +2768,8 @@ { "fileName": "src/lib/types.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L11" } ], "type": { @@ -2401,27 +2781,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 440, 438, 434, 436, 437, 442, 435, 441] + "children": [458, 459, 457, 453, 455, 456, 461, 454, 460] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L3" } ] }, { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -2432,7 +2812,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -2444,27 +2825,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] }, { - "id": 484, + "id": 514, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 485, + "id": 515, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2472,47 +2853,53 @@ "isOptional": true }, "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [485] + "children": [515] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, - "character": 17 + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" } ] }, { - "id": 443, + "id": 462, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 445, + "id": 464, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2521,7 +2908,8 @@ { "fileName": "src/lib/types.ts", "line": 17, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L17" } ], "type": { @@ -2530,7 +2918,7 @@ } }, { - "id": 452, + "id": 471, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -2539,22 +2927,23 @@ { "fileName": "src/lib/types.ts", "line": 24, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L24" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket", "dereferenced": { - "id": 433, + "id": 452, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 439, + "id": 458, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2565,7 +2954,8 @@ { "fileName": "src/lib/types.ts", "line": 9, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L9" } ], "type": { @@ -2577,7 +2967,7 @@ } }, { - "id": 440, + "id": 459, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2586,7 +2976,8 @@ { "fileName": "src/lib/types.ts", "line": 10, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L10" } ], "type": { @@ -2595,7 +2986,7 @@ } }, { - "id": 438, + "id": 457, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2606,7 +2997,8 @@ { "fileName": "src/lib/types.ts", "line": 8, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L8" } ], "type": { @@ -2615,7 +3007,7 @@ } }, { - "id": 434, + "id": 453, "name": "id", "kind": 1024, "kindString": "Property", @@ -2624,7 +3016,8 @@ { "fileName": "src/lib/types.ts", "line": 4, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L4" } ], "type": { @@ -2633,7 +3026,7 @@ } }, { - "id": 436, + "id": 455, "name": "name", "kind": 1024, "kindString": "Property", @@ -2642,7 +3035,8 @@ { "fileName": "src/lib/types.ts", "line": 6, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L6" } ], "type": { @@ -2651,7 +3045,7 @@ } }, { - "id": 437, + "id": 456, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2660,7 +3054,8 @@ { "fileName": "src/lib/types.ts", "line": 7, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L7" } ], "type": { @@ -2669,7 +3064,7 @@ } }, { - "id": 442, + "id": 461, "name": "public", "kind": 1024, "kindString": "Property", @@ -2678,7 +3073,8 @@ { "fileName": "src/lib/types.ts", "line": 12, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L12" } ], "type": { @@ -2687,7 +3083,7 @@ } }, { - "id": 435, + "id": 454, "name": "type", "kind": 1024, "kindString": "Property", @@ -2698,15 +3094,16 @@ { "fileName": "src/lib/types.ts", "line": 5, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L5" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -2715,7 +3112,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -2735,7 +3133,7 @@ } }, { - "id": 441, + "id": 460, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2744,7 +3142,8 @@ { "fileName": "src/lib/types.ts", "line": 11, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L11" } ], "type": { @@ -2756,22 +3155,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [439, 440, 438, 434, 436, 437, 442, 435, 441] + "children": [458, 459, 457, 453, 455, 456, 461, 454, 460] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L3" } ] } } }, { - "id": 449, + "id": 468, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2780,7 +3179,8 @@ { "fileName": "src/lib/types.ts", "line": 21, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L21" } ], "type": { @@ -2789,7 +3189,7 @@ } }, { - "id": 447, + "id": 466, "name": "id", "kind": 1024, "kindString": "Property", @@ -2798,7 +3198,8 @@ { "fileName": "src/lib/types.ts", "line": 19, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L19" } ], "type": { @@ -2807,7 +3208,7 @@ } }, { - "id": 450, + "id": 469, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2816,7 +3217,8 @@ { "fileName": "src/lib/types.ts", "line": 22, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L22" } ], "type": { @@ -2825,7 +3227,7 @@ } }, { - "id": 451, + "id": 470, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2834,7 +3236,8 @@ { "fileName": "src/lib/types.ts", "line": 23, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L23" } ], "type": { @@ -2849,13 +3252,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 444, + "id": 463, "name": "name", "kind": 1024, "kindString": "Property", @@ -2864,7 +3267,8 @@ { "fileName": "src/lib/types.ts", "line": 16, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L16" } ], "type": { @@ -2873,7 +3277,7 @@ } }, { - "id": 446, + "id": 465, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2882,7 +3286,8 @@ { "fileName": "src/lib/types.ts", "line": 18, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L18" } ], "type": { @@ -2891,7 +3296,7 @@ } }, { - "id": 448, + "id": 467, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2900,7 +3305,8 @@ { "fileName": "src/lib/types.ts", "line": 20, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L20" } ], "type": { @@ -2912,27 +3318,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [445, 452, 449, 447, 450, 451, 444, 446, 448] + "children": [464, 471, 468, 466, 469, 470, 463, 465, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 15, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L15" } ] }, { - "id": 453, + "id": 472, "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 457, + "id": 476, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2941,7 +3347,8 @@ { "fileName": "src/lib/types.ts", "line": 31, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L31" } ], "type": { @@ -2950,7 +3357,7 @@ } }, { - "id": 462, + "id": 481, "name": "cache_control", "kind": 1024, "kindString": "Property", @@ -2961,7 +3368,8 @@ { "fileName": "src/lib/types.ts", "line": 36, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L36" } ], "type": { @@ -2970,7 +3378,7 @@ } }, { - "id": 463, + "id": 482, "name": "content_type", "kind": 1024, "kindString": "Property", @@ -2981,7 +3389,8 @@ { "fileName": "src/lib/types.ts", "line": 37, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L37" } ], "type": { @@ -2990,7 +3399,7 @@ } }, { - "id": 459, + "id": 478, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2999,7 +3408,8 @@ { "fileName": "src/lib/types.ts", "line": 33, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L33" } ], "type": { @@ -3008,7 +3418,7 @@ } }, { - "id": 464, + "id": 483, "name": "etag", "kind": 1024, "kindString": "Property", @@ -3019,7 +3429,8 @@ { "fileName": "src/lib/types.ts", "line": 38, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L38" } ], "type": { @@ -3028,7 +3439,7 @@ } }, { - "id": 454, + "id": 473, "name": "id", "kind": 1024, "kindString": "Property", @@ -3037,7 +3448,8 @@ { "fileName": "src/lib/types.ts", "line": 28, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L28" } ], "type": { @@ -3046,7 +3458,7 @@ } }, { - "id": 460, + "id": 479, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -3055,7 +3467,8 @@ { "fileName": "src/lib/types.ts", "line": 34, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L34" } ], "type": { @@ -3064,7 +3477,7 @@ } }, { - "id": 465, + "id": 484, "name": "last_modified", "kind": 1024, "kindString": "Property", @@ -3075,7 +3488,8 @@ { "fileName": "src/lib/types.ts", "line": 39, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L39" } ], "type": { @@ -3084,7 +3498,7 @@ } }, { - "id": 466, + "id": 485, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -3095,7 +3509,8 @@ { "fileName": "src/lib/types.ts", "line": 40, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L40" } ], "type": { @@ -3110,13 +3525,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 456, + "id": 475, "name": "name", "kind": 1024, "kindString": "Property", @@ -3125,7 +3540,8 @@ { "fileName": "src/lib/types.ts", "line": 30, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L30" } ], "type": { @@ -3134,7 +3550,7 @@ } }, { - "id": 461, + "id": 480, "name": "size", "kind": 1024, "kindString": "Property", @@ -3145,7 +3561,8 @@ { "fileName": "src/lib/types.ts", "line": 35, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L35" } ], "type": { @@ -3154,7 +3571,7 @@ } }, { - "id": 458, + "id": 477, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -3163,7 +3580,8 @@ { "fileName": "src/lib/types.ts", "line": 32, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L32" } ], "type": { @@ -3172,7 +3590,7 @@ } }, { - "id": 455, + "id": 474, "name": "version", "kind": 1024, "kindString": "Property", @@ -3181,7 +3599,8 @@ { "fileName": "src/lib/types.ts", "line": 29, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L29" } ], "type": { @@ -3193,27 +3612,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [457, 462, 463, 459, 464, 454, 460, 465, 466, 456, 461, 458, 455] + "children": [476, 481, 482, 478, 483, 473, 479, 484, 485, 475, 480, 477, 474] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 27, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L27" } ] }, { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -3221,13 +3640,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -3236,7 +3669,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -3244,13 +3677,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -3259,7 +3746,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -3267,13 +3754,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -3282,7 +3775,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3290,13 +3783,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -3311,13 +3810,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -3325,13 +3824,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -3346,13 +3851,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -3360,13 +3865,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -3378,27 +3889,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] }, { - "id": 486, + "id": 516, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 487, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -3406,8 +3917,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 + "line": 126, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L126" } ], "type": { @@ -3419,27 +3931,27 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [487] + "children": [517] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 17 + "line": 125, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L125" } ] }, { - "id": 479, + "id": 498, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 480, + "id": 499, "name": "limit", "kind": 1024, "kindString": "Property", @@ -3447,11 +3959,21 @@ "isOptional": true }, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ + "summary": [ + { + "kind": "text", + "text": "The number of files you want to be returned." + } + ], + "blockTags": [ { - "tag": "default", - "text": "100\n" + "tag": "@default", + "content": [ + { + "kind": "text", + "text": "100" + } + ] } ] }, @@ -3459,7 +3981,8 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L86" } ], "type": { @@ -3468,7 +3991,7 @@ } }, { - "id": 481, + "id": 500, "name": "offset", "kind": 1024, "kindString": "Property", @@ -3476,13 +3999,19 @@ "isOptional": true }, "comment": { - "shortText": "The starting position." + "summary": [ + { + "kind": "text", + "text": "The starting position." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L91" } ], "type": { @@ -3491,7 +4020,7 @@ } }, { - "id": 483, + "id": 502, "name": "search", "kind": 1024, "kindString": "Property", @@ -3499,13 +4028,19 @@ "isOptional": true }, "comment": { - "shortText": "The search string to filter files by." + "summary": [ + { + "kind": "text", + "text": "The search string to filter files by." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L101" } ], "type": { @@ -3514,7 +4049,7 @@ } }, { - "id": 482, + "id": 501, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -3522,28 +4057,34 @@ "isOptional": true }, "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." + "summary": [ + { + "kind": "text", + "text": "The column to sort by. Can be any column inside a FileObject." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 96, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L96" } ], "type": { "type": "reference", - "id": 467, + "id": 486, "name": "SortBy", "dereferenced": { - "id": 467, + "id": 486, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, + "id": 487, "name": "column", "kind": 1024, "kindString": "Property", @@ -3554,7 +4095,8 @@ { "fileName": "src/lib/types.ts", "line": 44, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" } ], "type": { @@ -3563,7 +4105,7 @@ } }, { - "id": 469, + "id": 488, "name": "order", "kind": 1024, "kindString": "Property", @@ -3574,7 +4116,8 @@ { "fileName": "src/lib/types.ts", "line": 45, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" } ], "type": { @@ -3586,15 +4129,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [487, 488] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 43, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" } ] } @@ -3604,28 +4147,28 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [480, 481, 483, 482] + "children": [499, 500, 502, 501] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 81, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L81" } ] }, { - "id": 467, - "name": "SortBy", + "id": 503, + "name": "SearchV2Options", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, - "name": "column", + "id": 506, + "name": "cursor", "kind": 1024, "kindString": "Property", "flags": { @@ -3634,8 +4177,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 + "line": 107, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L107" } ], "type": { @@ -3644,8 +4188,8 @@ } }, { - "id": 469, - "name": "order", + "id": 504, + "name": "limit", "kind": 1024, "kindString": "Property", "flags": { @@ -3654,110 +4198,363 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 + "line": 105, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L105" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 505, + "name": "prefix", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L106" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 507, + "name": "with_delimiter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L108" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [506, 504, 505, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 17 + "line": 104, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L104" } ] }, { - "id": 488, - "name": "TransformOptions", + "id": 508, + "name": "SearchV2Result", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, - "name": "format", + "id": 510, + "name": "folders", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 113, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" } ], "type": { - "type": "literal", - "value": "origin" + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 512, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [512] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 11, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L113" + } + ] + } + } } }, { - "id": 490, - "name": "height", + "id": 509, + "name": "hasNext", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The height of the image in pixels." - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 112, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L112" } ], "type": { "type": "intrinsic", - "name": "number" + "name": "boolean" } }, { - "id": 492, - "name": "quality", + "id": 513, + "name": "objects", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 114, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L114" } ], "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 491, + "type": "array", + "elementType": { + "type": "reference", + "id": 462, + "name": "FileObject" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [510, 509, 513] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L111" + } + ] + }, + { + "id": 486, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 487, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 44, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 488, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [487, 488] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" + } + ] + }, + { + "id": 518, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 523, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" + } + ], + "type": { + "type": "literal", + "value": "origin" + } + }, + { + "id": 520, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 522, + "name": "quality", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -3765,13 +4562,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -3793,7 +4596,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -3801,13 +4604,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -3819,20 +4628,20 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] }, { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -3841,7 +4650,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -3859,7 +4669,7 @@ } }, { - "id": 494, + "id": 524, "name": "Camelize", "kind": 4194304, "kindString": "Type alias", @@ -3867,13 +4677,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 151, - "character": 12 + "line": 164, + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L164" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 495, + "id": 525, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -3888,7 +4699,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -3900,7 +4711,7 @@ }, "objectType": { "type": "reference", - "id": 495, + "id": 525, "name": "T" } }, @@ -3919,9 +4730,9 @@ "name": "string" } ], + "name": "Extract", "qualifiedName": "Extract", - "package": "typescript", - "name": "Extract" + "package": "typescript" } ], "name": "CamelCase" @@ -3929,7 +4740,7 @@ } }, { - "id": 496, + "id": 526, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -3938,19 +4749,20 @@ { "fileName": "src/lib/errors.ts", "line": 10, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/errors.ts#L10" } ], "signatures": [ { - "id": 497, + "id": 527, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 498, + "id": 528, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -3967,7 +4779,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -3978,30 +4790,27 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [504, 335, 499, 520] + "children": [534, 351, 529, 550] }, { "title": "Interfaces", - "kind": 256, - "children": [433, 477, 484, 443, 453, 470, 486, 479, 467, 488] + "children": [452, 496, 514, 462, 472, 489, 516, 498, 503, 508, 486, 518] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [432, 494] + "children": [451, 524] }, { "title": "Functions", - "kind": 64, - "children": [496] + "children": [526] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/index.ts#L1" } ] }, @@ -4028,8 +4837,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 13, - "character": 2 + "line": 14, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L14" } ], "signatures": [ @@ -4065,6 +4875,14 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 16, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L16" + } + ], "indexSignature": { "id": 9, "name": "__index", @@ -4108,6 +4926,13 @@ "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { "id": 13, @@ -4124,9 +4949,9 @@ "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { @@ -4139,9 +4964,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4150,14 +4975,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4187,7 +5012,7 @@ ] }, { - "id": 44, + "id": 47, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -4195,30 +5020,51 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 104, - "character": 8 + "line": 119, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L119" } ], "signatures": [ { - "id": 45, + "id": 48, "name": "createBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id" + "summary": [ + { + "kind": "text", + "text": "Creates a new Storage bucket" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "newly created bucket id" + } + ] + } + ] }, "parameters": [ { - "id": 46, + "id": 49, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are creating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are creating." + } + ] }, "type": { "type": "intrinsic", @@ -4226,7 +5072,7 @@ } }, { - "id": 47, + "id": 50, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -4234,14 +5080,14 @@ "type": { "type": "reflection", "declaration": { - "id": 48, + "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 51, + "id": 54, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -4249,13 +5095,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 109, - "character": 6 + "line": 124, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L124" } ], "type": { @@ -4276,7 +5128,7 @@ } }, { - "id": 50, + "id": 53, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -4284,13 +5136,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 108, - "character": 6 + "line": 123, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L123" } ], "type": { @@ -4312,19 +5170,25 @@ } }, { - "id": 49, + "id": 52, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 107, - "character": 6 + "line": 122, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L122" } ], "type": { @@ -4333,7 +5197,7 @@ } }, { - "id": 52, + "id": 55, "name": "type", "kind": 1024, "kindString": "Property", @@ -4341,21 +5205,39 @@ "isOptional": true }, "comment": { - "shortText": "(private-beta) specifies the bucket type. see `BucketType` for more details.\n - default bucket type is `STANDARD`\n" + "summary": [ + { + "kind": "text", + "text": "(private-beta) specifies the bucket type. see " + }, + { + "kind": "code", + "text": "`BucketType`" + }, + { + "kind": "text", + "text": " for more details.\n - default bucket type is " + }, + { + "kind": "code", + "text": "`STANDARD`" + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 110, - "character": 6 + "line": 125, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L125" } ], "type": { "type": "reference", - "id": 432, + "id": 451, "name": "BucketType", "dereferenced": { - "id": 432, + "id": 451, "name": "BucketType", "kind": 4194304, "kindString": "Type alias", @@ -4364,7 +5246,8 @@ { "fileName": "src/lib/types.ts", "line": 1, - "character": 12 + "character": 12, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L1" } ], "type": { @@ -4387,8 +5270,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [51, 50, 49, 52] + "children": [54, 53, 52, 55] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L121" } ] } @@ -4405,14 +5295,14 @@ { "type": "reflection", "declaration": { - "id": 53, + "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 54, + "id": 57, "name": "data", "kind": 1024, "kindString": "Property", @@ -4420,8 +5310,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 116, - "character": 8 + "line": 131, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L131" } ], "type": { @@ -4429,7 +5320,7 @@ "typeArguments": [ { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" }, { @@ -4437,13 +5328,13 @@ "value": "name" } ], + "name": "Pick", "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "package": "typescript" } }, { - "id": 55, + "id": 58, "name": "error", "kind": 1024, "kindString": "Property", @@ -4451,8 +5342,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 8 + "line": 132, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L132" } ], "type": { @@ -4464,8 +5356,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [54, 55] + "children": [57, 58] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 130, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L130" } ] } @@ -4473,14 +5372,14 @@ { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 57, + "id": 60, "name": "data", "kind": 1024, "kindString": "Property", @@ -4488,8 +5387,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 + "line": 135, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L135" } ], "type": { @@ -4498,7 +5398,7 @@ } }, { - "id": 58, + "id": 61, "name": "error", "kind": 1024, "kindString": "Property", @@ -4506,13 +5406,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 + "line": 136, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L136" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4520,8 +5421,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [57, 58] + "children": [60, 61] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 134, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L134" } ] } @@ -4529,15 +5437,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 86, + "id": 89, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -4545,29 +5453,48 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 240, - "character": 8 + "line": 264, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L264" } ], "signatures": [ { - "id": 87, + "id": 90, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + "summary": [ + { + "kind": "text", + "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " + }, + { + "kind": "code", + "text": "`empty()`" + }, + { + "kind": "text", + "text": " the bucket." + } + ] }, "parameters": [ { - "id": 88, + "id": 91, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to delete." + } + ] }, "type": { "type": "intrinsic", @@ -4584,14 +5511,14 @@ { "type": "reflection", "declaration": { - "id": 89, + "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 90, + "id": 93, "name": "data", "kind": 1024, "kindString": "Property", @@ -4599,21 +5526,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 8 + "line": 268, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 94, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 95, "name": "message", "kind": 1024, "kindString": "Property", @@ -4621,8 +5549,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 244, - "character": 16 + "line": 268, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ], "type": { @@ -4634,15 +5563,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [92] + "children": [95] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 268, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L268" } ] } } }, { - "id": 93, + "id": 96, "name": "error", "kind": 1024, "kindString": "Property", @@ -4650,8 +5586,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 245, - "character": 8 + "line": 269, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L269" } ], "type": { @@ -4663,8 +5600,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [90, 93] + "children": [93, 96] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 267, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L267" } ] } @@ -4672,14 +5616,14 @@ { "type": "reflection", "declaration": { - "id": 94, + "id": 97, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 95, + "id": 98, "name": "data", "kind": 1024, "kindString": "Property", @@ -4687,8 +5631,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 248, - "character": 8 + "line": 272, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L272" } ], "type": { @@ -4697,7 +5642,7 @@ } }, { - "id": 96, + "id": 99, "name": "error", "kind": 1024, "kindString": "Property", @@ -4705,13 +5650,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 249, - "character": 8 + "line": 273, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4719,8 +5665,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [95, 96] + "children": [98, 99] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 271, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L271" } ] } @@ -4728,15 +5681,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 75, + "id": 78, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -4744,29 +5697,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8 + "line": 226, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L226" } ], "signatures": [ { - "id": 76, + "id": 79, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Removes all objects inside a single bucket." + "summary": [ + { + "kind": "text", + "text": "Removes all objects inside a single bucket." + } + ] }, "parameters": [ { - "id": 77, + "id": 80, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to empty." + } + ] }, "type": { "type": "intrinsic", @@ -4783,14 +5747,14 @@ { "type": "reflection", "declaration": { - "id": 78, + "id": 81, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, + "id": 82, "name": "data", "kind": 1024, "kindString": "Property", @@ -4798,21 +5762,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 8 + "line": 230, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 83, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 81, + "id": 84, "name": "message", "kind": 1024, "kindString": "Property", @@ -4820,8 +5785,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 209, - "character": 16 + "line": 230, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ], "type": { @@ -4833,15 +5799,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [81] + "children": [84] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 230, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L230" } ] } } }, { - "id": 82, + "id": 85, "name": "error", "kind": 1024, "kindString": "Property", @@ -4849,8 +5822,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 210, - "character": 8 + "line": 231, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L231" } ], "type": { @@ -4862,8 +5836,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [79, 82] + "children": [82, 85] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 229, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L229" } ] } @@ -4871,14 +5852,14 @@ { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "data", "kind": 1024, "kindString": "Property", @@ -4886,8 +5867,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 213, - "character": 8 + "line": 234, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L234" } ], "type": { @@ -4896,7 +5878,7 @@ } }, { - "id": 85, + "id": 88, "name": "error", "kind": 1024, "kindString": "Property", @@ -4904,13 +5886,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 214, - "character": 8 + "line": 235, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L235" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -4918,8 +5901,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [84, 85] + "children": [87, 88] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 233, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L233" } ] } @@ -4927,15 +5917,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 35, + "id": 38, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -4943,29 +5933,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 65, - "character": 8 + "line": 77, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L77" } ], "signatures": [ { - "id": 36, + "id": 39, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing Storage bucket." + } + ] }, "parameters": [ { - "id": 37, + "id": 40, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the bucket you would like to retrieve." + } + ] }, "type": { "type": "intrinsic", @@ -4982,14 +5983,14 @@ { "type": "reflection", "declaration": { - "id": 38, + "id": 41, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 39, + "id": 42, "name": "data", "kind": 1024, "kindString": "Property", @@ -4997,18 +5998,19 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 69, - "character": 8 + "line": 81, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L81" } ], "type": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } }, { - "id": 40, + "id": 43, "name": "error", "kind": 1024, "kindString": "Property", @@ -5016,8 +6018,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 70, - "character": 8 + "line": 82, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L82" } ], "type": { @@ -5029,8 +6032,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [39, 40] + "children": [42, 43] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 80, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L80" } ] } @@ -5038,14 +6048,14 @@ { "type": "reflection", "declaration": { - "id": 41, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 42, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -5053,8 +6063,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8 + "line": 85, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L85" } ], "type": { @@ -5063,7 +6074,7 @@ } }, { - "id": 43, + "id": 46, "name": "error", "kind": 1024, "kindString": "Property", @@ -5071,13 +6082,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8 + "line": 86, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L86" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5085,8 +6097,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [42, 43] + "children": [45, 46] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L84" } ] } @@ -5094,15 +6113,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 27, + "id": 30, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -5110,19 +6129,25 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 38, - "character": 8 + "line": 47, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L47" } ], "signatures": [ { - "id": 28, + "id": 31, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of all Storage buckets within an existing project." + } + ] }, "type": { "type": "reference", @@ -5133,14 +6158,14 @@ { "type": "reflection", "declaration": { - "id": 29, + "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 30, + "id": 33, "name": "data", "kind": 1024, "kindString": "Property", @@ -5148,21 +6173,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 40, - "character": 8 + "line": 49, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L49" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 433, + "id": 452, "name": "Bucket" } } }, { - "id": 31, + "id": 34, "name": "error", "kind": 1024, "kindString": "Property", @@ -5170,8 +6196,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 41, - "character": 8 + "line": 50, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L50" } ], "type": { @@ -5183,8 +6210,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [30, 31] + "children": [33, 34] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L48" } ] } @@ -5192,14 +6226,14 @@ { "type": "reflection", "declaration": { - "id": 32, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 33, + "id": 36, "name": "data", "kind": 1024, "kindString": "Property", @@ -5207,8 +6241,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 44, - "character": 8 + "line": 53, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L53" } ], "type": { @@ -5217,7 +6252,7 @@ } }, { - "id": 34, + "id": 37, "name": "error", "kind": 1024, "kindString": "Property", @@ -5225,13 +6260,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 45, - "character": 8 + "line": 54, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L54" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5239,8 +6275,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [33, 34] + "children": [36, 37] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L52" } ] } @@ -5248,15 +6291,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" + } + } + ] + }, + { + "id": 28, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 39, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L39" + } + ], + "signatures": [ + { + "id": 29, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 3, + "name": "default" } } ] }, { - "id": 59, + "id": 62, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -5264,29 +6346,40 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 160, - "character": 8 + "line": 178, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L178" } ], "signatures": [ { - "id": 60, + "id": 63, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates a Storage bucket" + "summary": [ + { + "kind": "text", + "text": "Updates a Storage bucket" + } + ] }, "parameters": [ { - "id": 61, + "id": 64, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A unique identifier for the bucket you are updating." + "summary": [ + { + "kind": "text", + "text": "A unique identifier for the bucket you are updating." + } + ] }, "type": { "type": "intrinsic", @@ -5294,7 +6387,7 @@ } }, { - "id": 62, + "id": 65, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5302,14 +6395,14 @@ "type": { "type": "reflection", "declaration": { - "id": 63, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 66, + "id": 69, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -5317,13 +6410,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png.\n" + "summary": [ + { + "kind": "text", + "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 165, - "character": 6 + "line": 183, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L183" } ], "type": { @@ -5344,7 +6443,7 @@ } }, { - "id": 65, + "id": 68, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -5352,13 +6451,19 @@ "isOptional": true }, "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + "summary": [ + { + "kind": "text", + "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 164, - "character": 6 + "line": 182, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L182" } ], "type": { @@ -5380,19 +6485,25 @@ } }, { - "id": 64, + "id": 67, "name": "public", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + "summary": [ + { + "kind": "text", + "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." + } + ] }, "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 163, - "character": 6 + "line": 181, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L181" } ], "type": { @@ -5404,8 +6515,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [66, 65, 64] + "children": [69, 68, 67] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 180, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L180" } ] } @@ -5421,14 +6539,14 @@ { "type": "reflection", "declaration": { - "id": 67, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 68, + "id": 71, "name": "data", "kind": 1024, "kindString": "Property", @@ -5436,21 +6554,22 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 8 + "line": 187, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { "type": "reflection", "declaration": { - "id": 69, + "id": 72, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 73, "name": "message", "kind": 1024, "kindString": "Property", @@ -5458,8 +6577,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 169, - "character": 16 + "line": 187, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ], "type": { @@ -5471,15 +6591,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [70] + "children": [73] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 187, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L187" } ] } } }, { - "id": 71, + "id": 74, "name": "error", "kind": 1024, "kindString": "Property", @@ -5487,8 +6614,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 170, - "character": 8 + "line": 188, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L188" } ], "type": { @@ -5500,8 +6628,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [68, 71] + "children": [71, 74] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 186, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L186" } ] } @@ -5509,14 +6644,14 @@ { "type": "reflection", "declaration": { - "id": 72, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 73, + "id": 76, "name": "data", "kind": 1024, "kindString": "Property", @@ -5524,8 +6659,9 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 173, - "character": 8 + "line": 191, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L191" } ], "type": { @@ -5534,7 +6670,7 @@ } }, { - "id": 74, + "id": 77, "name": "error", "kind": 1024, "kindString": "Property", @@ -5542,13 +6678,14 @@ "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", - "line": 174, - "character": 8 + "line": 192, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L192" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -5556,8 +6693,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [73, 74] + "children": [76, 77] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L190" } ] } @@ -5565,9 +6709,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5576,26 +6720,25 @@ "groups": [ { "title": "Constructors", - "kind": 512, "children": [4] }, { "title": "Methods", - "kind": 2048, - "children": [44, 86, 75, 35, 27, 59] + "children": [47, 89, 78, 38, 30, 28, 62] } ], "sources": [ { "fileName": "src/packages/StorageBucketApi.ts", "line": 8, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L8" } ], "extendedBy": [ { "type": "reference", - "id": 335, + "id": 351, "name": "StorageClient" } ] @@ -5604,7 +6747,6 @@ "groups": [ { "title": "Classes", - "kind": 128, "children": [3] } ], @@ -5612,26 +6754,27 @@ { "fileName": "src/packages/StorageBucketApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageBucketApi.ts#L1" } ] }, { - "id": 97, + "id": 100, "name": "packages/StorageFileApi", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 98, + "id": 101, "name": "default", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 99, + "id": 102, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -5639,20 +6782,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 48, - "character": 2 + "line": 51, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L51" } ], "signatures": [ { - "id": 100, + "id": 103, "name": "new default", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 101, + "id": 104, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -5663,7 +6807,7 @@ } }, { - "id": 102, + "id": 105, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -5671,20 +6815,28 @@ "type": { "type": "reflection", "declaration": { - "id": 103, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 53, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L53" + } + ], "indexSignature": { - "id": 104, + "id": 107, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 105, + "id": 108, "name": "key", "kind": 32768, "flags": {}, @@ -5704,7 +6856,7 @@ "defaultValue": "{}" }, { - "id": 106, + "id": 109, "name": "bucketId", "kind": 32768, "kindString": "Parameter", @@ -5717,7 +6869,7 @@ } }, { - "id": 107, + "id": 110, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -5727,34 +6879,41 @@ "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 17731, + "character": 17 + } + ], "signatures": [ { - "id": 109, + "id": 112, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 110, + "id": 113, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" } }, { - "id": 111, + "id": 114, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -5763,9 +6922,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -5774,14 +6933,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -5791,14 +6950,14 @@ ], "type": { "type": "reference", - "id": 98, + "id": 101, "name": "default" } } ] }, { - "id": 213, + "id": 219, "name": "copy", "kind": 2048, "kindString": "Method", @@ -5806,29 +6965,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 355, - "character": 8 + "line": 378, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L378" } ], "signatures": [ { - "id": 214, + "id": 220, "name": "copy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Copies an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 215, + "id": 221, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -5836,13 +7014,26 @@ } }, { - "id": 216, + "id": 222, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-copy.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -5850,7 +7041,7 @@ } }, { - "id": 217, + "id": 223, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5858,21 +7049,26 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions", "dereferenced": { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -5883,7 +7079,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -5895,15 +7092,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] } @@ -5919,14 +7116,14 @@ { "type": "reflection", "declaration": { - "id": 218, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 225, "name": "data", "kind": 1024, "kindString": "Property", @@ -5934,21 +7131,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 8 + "line": 384, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 226, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 221, + "id": 227, "name": "path", "kind": 1024, "kindString": "Property", @@ -5956,8 +7154,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 361, - "character": 16 + "line": 384, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ], "type": { @@ -5969,15 +7168,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [221] + "children": [227] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 384, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L384" } ] } } }, { - "id": 222, + "id": 228, "name": "error", "kind": 1024, "kindString": "Property", @@ -5985,8 +7191,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 362, - "character": 8 + "line": 385, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L385" } ], "type": { @@ -5998,8 +7205,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [219, 222] + "children": [225, 228] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L383" } ] } @@ -6007,14 +7221,14 @@ { "type": "reflection", "declaration": { - "id": 223, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 224, + "id": 230, "name": "data", "kind": 1024, "kindString": "Property", @@ -6022,8 +7236,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 365, - "character": 8 + "line": 388, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L388" } ], "type": { @@ -6032,7 +7247,7 @@ } }, { - "id": 225, + "id": 231, "name": "error", "kind": 1024, "kindString": "Property", @@ -6040,13 +7255,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 366, - "character": 8 + "line": 389, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L389" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6054,8 +7270,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [224, 225] + "children": [230, 231] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 387, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L387" } ] } @@ -6063,15 +7286,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 169, + "id": 175, "name": "createSignedUploadUrl", "kind": 2048, "kindString": "Method", @@ -6079,29 +7302,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 225, - "character": 8 + "line": 242, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L242" } ], "signatures": [ { - "id": 170, + "id": 176, "name": "createSignedUploadUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + "summary": [ + { + "kind": "text", + "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." + } + ] }, "parameters": [ { - "id": 171, + "id": 177, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -6109,7 +7351,7 @@ } }, { - "id": 172, + "id": 178, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6119,26 +7361,32 @@ "type": { "type": "reflection", "declaration": { - "id": 173, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 180, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + "summary": [ + { + "kind": "text", + "text": "If set to true, allows the file to be overwritten if it already exists." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, - "character": 16 + "line": 244, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ], "type": { @@ -6150,8 +7398,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [174] + "children": [180] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 244, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L244" } ] } @@ -6167,14 +7422,14 @@ { "type": "reflection", "declaration": { - "id": 175, + "id": 181, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 176, + "id": 182, "name": "data", "kind": 1024, "kindString": "Property", @@ -6182,21 +7437,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 8 + "line": 247, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { "type": "reflection", "declaration": { - "id": 177, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 180, + "id": 186, "name": "path", "kind": 1024, "kindString": "Property", @@ -6204,8 +7460,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 50 + "line": 247, + "character": 50, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -6214,7 +7471,7 @@ } }, { - "id": 178, + "id": 184, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -6222,8 +7479,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 16 + "line": 247, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -6232,7 +7490,7 @@ } }, { - "id": 179, + "id": 185, "name": "token", "kind": 1024, "kindString": "Property", @@ -6240,8 +7498,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 230, - "character": 35 + "line": 247, + "character": 35, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ], "type": { @@ -6253,15 +7512,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [180, 178, 179] + "children": [186, 184, 185] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 247, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L247" } ] } } }, { - "id": 181, + "id": 187, "name": "error", "kind": 1024, "kindString": "Property", @@ -6269,8 +7535,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 + "line": 248, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L248" } ], "type": { @@ -6282,23 +7549,30 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [176, 181] + "children": [182, 187] } - ] - } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 246, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L246" + } + ] + } }, { "type": "reflection", "declaration": { - "id": 182, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 183, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -6306,8 +7580,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 234, - "character": 8 + "line": 251, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L251" } ], "type": { @@ -6316,7 +7591,7 @@ } }, { - "id": 184, + "id": 190, "name": "error", "kind": 1024, "kindString": "Property", @@ -6324,13 +7599,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 235, - "character": 8 + "line": 252, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L252" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6338,8 +7614,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [183, 184] + "children": [189, 190] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 250, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L250" } ] } @@ -6347,15 +7630,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 226, + "id": 232, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -6363,29 +7646,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 399, - "character": 8 + "line": 425, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L425" } ], "signatures": [ { - "id": 227, + "id": 233, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 228, + "id": 234, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -6393,13 +7695,26 @@ } }, { - "id": 229, + "id": 235, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URL expires. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for a URL which is valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -6407,7 +7722,7 @@ } }, { - "id": 230, + "id": 236, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6417,14 +7732,14 @@ "type": { "type": "reflection", "declaration": { - "id": 231, + "id": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 232, + "id": 238, "name": "download", "kind": 1024, "kindString": "Property", @@ -6432,13 +7747,19 @@ "isOptional": true }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 16 + "line": 428, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { @@ -6456,7 +7777,7 @@ } }, { - "id": 233, + "id": 239, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6464,28 +7785,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 402, - "character": 45 + "line": 428, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -6493,14 +7820,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -6509,7 +7841,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -6517,13 +7849,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -6532,7 +7870,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -6540,13 +7878,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -6555,7 +7899,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -6563,13 +7907,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -6591,7 +7941,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -6599,13 +7949,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -6617,15 +7973,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -6635,8 +7991,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [232, 233] + "children": [238, 239] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 428, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L428" } ] } @@ -6652,14 +8015,14 @@ { "type": "reflection", "declaration": { - "id": 234, + "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 235, + "id": 241, "name": "data", "kind": 1024, "kindString": "Property", @@ -6667,21 +8030,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 8 + "line": 431, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { "type": "reflection", "declaration": { - "id": 236, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 243, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -6689,8 +8053,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 405, - "character": 16 + "line": 431, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ], "type": { @@ -6702,15 +8067,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [237] + "children": [243] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 431, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L431" } ] } } }, { - "id": 238, + "id": 244, "name": "error", "kind": 1024, "kindString": "Property", @@ -6718,8 +8090,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 406, - "character": 8 + "line": 432, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L432" } ], "type": { @@ -6731,8 +8104,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [235, 238] + "children": [241, 244] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 430, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L430" } ] } @@ -6740,14 +8120,14 @@ { "type": "reflection", "declaration": { - "id": 239, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 240, + "id": 246, "name": "data", "kind": 1024, "kindString": "Property", @@ -6755,8 +8135,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 409, - "character": 8 + "line": 435, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L435" } ], "type": { @@ -6765,7 +8146,7 @@ } }, { - "id": 241, + "id": 247, "name": "error", "kind": 1024, "kindString": "Property", @@ -6773,13 +8154,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 410, - "character": 8 + "line": 436, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L436" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -6787,8 +8169,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [240, 241] + "children": [246, 247] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 434, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L434" } ] } @@ -6796,15 +8185,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 242, + "id": 248, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -6812,29 +8201,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 444, - "character": 8 + "line": 473, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L473" } ], "signatures": [ { - "id": 243, + "id": 249, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + "summary": [ + { + "kind": "text", + "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + } + ] }, "parameters": [ { - "id": 244, + "id": 250, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." + "summary": [ + { + "kind": "text", + "text": "The file paths to be downloaded, including the current file names. For example " + }, + { + "kind": "code", + "text": "`['folder/image.png', 'folder2/image2.png']`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "array", @@ -6845,13 +8253,26 @@ } }, { - "id": 245, + "id": 251, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." + "summary": [ + { + "kind": "text", + "text": "The number of seconds until the signed URLs expire. For example, " + }, + { + "kind": "code", + "text": "`60`" + }, + { + "kind": "text", + "text": " for URLs which are valid for one minute." + } + ] }, "type": { "type": "intrinsic", @@ -6859,7 +8280,7 @@ } }, { - "id": 246, + "id": 252, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6869,26 +8290,32 @@ "type": { "type": "reflection", "declaration": { - "id": 247, + "id": 253, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 248, + "id": 254, "name": "download", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "summary": [ + { + "kind": "text", + "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 447, - "character": 16 + "line": 476, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ], "type": { @@ -6909,8 +8336,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [248] + "children": [254] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 476, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L476" } ] } @@ -6926,14 +8360,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 256, "name": "data", "kind": 1024, "kindString": "Property", @@ -6941,8 +8375,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 8 + "line": 479, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6950,14 +8385,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 251, + "id": 257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 252, + "id": 258, "name": "error", "kind": 1024, "kindString": "Property", @@ -6965,8 +8400,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 16 + "line": 479, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -6984,7 +8420,7 @@ } }, { - "id": 253, + "id": 259, "name": "path", "kind": 1024, "kindString": "Property", @@ -6992,8 +8428,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 38 + "line": 479, + "character": 38, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -7011,7 +8448,7 @@ } }, { - "id": 254, + "id": 260, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -7019,8 +8456,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 450, - "character": 59 + "line": 479, + "character": 59, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ], "type": { @@ -7032,8 +8470,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [252, 253, 254] + "children": [258, 259, 260] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 479, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L479" } ] } @@ -7041,7 +8486,7 @@ } }, { - "id": 255, + "id": 261, "name": "error", "kind": 1024, "kindString": "Property", @@ -7049,8 +8494,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 451, - "character": 8 + "line": 480, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L480" } ], "type": { @@ -7062,8 +8508,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [250, 255] + "children": [256, 261] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 478, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L478" } ] } @@ -7071,14 +8524,14 @@ { "type": "reflection", "declaration": { - "id": 256, + "id": 262, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 263, "name": "data", "kind": 1024, "kindString": "Property", @@ -7086,8 +8539,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 454, - "character": 8 + "line": 483, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L483" } ], "type": { @@ -7096,7 +8550,7 @@ } }, { - "id": 258, + "id": 264, "name": "error", "kind": 1024, "kindString": "Property", @@ -7104,13 +8558,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 455, - "character": 8 + "line": 484, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L484" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7118,8 +8573,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [257, 258] + "children": [263, 264] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 482, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L482" } ] } @@ -7127,15 +8589,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 259, + "id": 265, "name": "download", "kind": 2048, "kindString": "Method", @@ -7143,29 +8605,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 493, - "character": 8 + "line": 525, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L525" } ], "signatures": [ { - "id": 260, + "id": 266, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead." + "summary": [ + { + "kind": "text", + "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " + }, + { + "kind": "code", + "text": "`getPublicUrl`" + }, + { + "kind": "text", + "text": " instead." + } + ] }, "parameters": [ { - "id": 261, + "id": 267, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The full path and file name of the file to be downloaded. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -7173,7 +8662,7 @@ } }, { - "id": 262, + "id": 268, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7183,14 +8672,14 @@ "type": { "type": "reflection", "declaration": { - "id": 263, + "id": 269, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 264, + "id": 270, "name": "transform", "kind": 1024, "kindString": "Property", @@ -7198,28 +8687,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 495, - "character": 16 + "line": 527, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -7227,14 +8722,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -7243,7 +8743,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -7251,13 +8751,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -7266,7 +8772,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -7274,13 +8780,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -7289,7 +8801,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -7297,13 +8809,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -7325,7 +8843,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -7333,13 +8851,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -7351,15 +8875,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -7369,8 +8893,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [264] + "children": [270] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 527, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L527" } ] } @@ -7386,14 +8917,14 @@ { "type": "reflection", "declaration": { - "id": 265, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 266, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -7401,19 +8932,20 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 498, - "character": 8 + "line": 530, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L530" } ], "type": { "type": "reference", + "name": "Blob", "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "package": "typescript" } }, { - "id": 267, + "id": 273, "name": "error", "kind": 1024, "kindString": "Property", @@ -7421,8 +8953,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 499, - "character": 8 + "line": 531, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L531" } ], "type": { @@ -7434,8 +8967,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [266, 267] + "children": [272, 273] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 529, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L529" } ] } @@ -7443,14 +8983,14 @@ { "type": "reflection", "declaration": { - "id": 268, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 275, "name": "data", "kind": 1024, "kindString": "Property", @@ -7458,8 +8998,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 502, - "character": 8 + "line": 534, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L534" } ], "type": { @@ -7468,7 +9009,7 @@ } }, { - "id": 270, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -7476,13 +9017,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 503, - "character": 8 + "line": 535, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L535" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7490,8 +9032,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [269, 270] + "children": [275, 276] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 533, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L533" } ] } @@ -7499,15 +9048,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 280, + "id": 286, "name": "exists", "kind": 2048, "kindString": "Method", @@ -7515,30 +9064,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 565, - "character": 8 + "line": 603, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L603" } ], "signatures": [ { - "id": 281, + "id": 287, "name": "exists", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Checks the existence of a file." + "summary": [ + { + "kind": "text", + "text": "Checks the existence of a file." + } + ] }, "parameters": [ { - "id": 282, + "id": 288, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -7554,14 +9106,14 @@ { "type": "reflection", "declaration": { - "id": 283, + "id": 289, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 290, "name": "data", "kind": 1024, "kindString": "Property", @@ -7569,8 +9121,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 569, - "character": 8 + "line": 607, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L607" } ], "type": { @@ -7579,7 +9132,7 @@ } }, { - "id": 285, + "id": 291, "name": "error", "kind": 1024, "kindString": "Property", @@ -7587,8 +9140,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 570, - "character": 8 + "line": 608, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L608" } ], "type": { @@ -7600,8 +9154,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [284, 285] + "children": [290, 291] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 606, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L606" } ] } @@ -7609,14 +9170,14 @@ { "type": "reflection", "declaration": { - "id": 286, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 293, "name": "data", "kind": 1024, "kindString": "Property", @@ -7624,8 +9185,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 573, - "character": 8 + "line": 611, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L611" } ], "type": { @@ -7634,7 +9196,7 @@ } }, { - "id": 288, + "id": 294, "name": "error", "kind": 1024, "kindString": "Property", @@ -7642,13 +9204,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 574, - "character": 8 + "line": 612, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L612" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -7656,8 +9219,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [287, 288] + "children": [293, 294] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 610, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L610" } ] } @@ -7665,15 +9235,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 289, + "id": 295, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -7681,29 +9251,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 606, - "character": 2 + "line": 647, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L647" } ], "signatures": [ { - "id": 290, + "id": 296, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + "summary": [ + { + "kind": "text", + "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + } + ] }, "parameters": [ { - "id": 291, + "id": 297, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The path and name of the file to generate the public URL for. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -7711,7 +9300,7 @@ } }, { - "id": 292, + "id": 298, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7721,14 +9310,14 @@ "type": { "type": "reflection", "declaration": { - "id": 293, + "id": 299, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 294, + "id": 300, "name": "download", "kind": 1024, "kindString": "Property", @@ -7736,13 +9325,19 @@ "isOptional": true }, "comment": { - "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + "summary": [ + { + "kind": "text", + "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 16 + "line": 649, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { @@ -7760,7 +9355,7 @@ } }, { - "id": 295, + "id": 301, "name": "transform", "kind": 1024, "kindString": "Property", @@ -7768,28 +9363,34 @@ "isOptional": true }, "comment": { - "shortText": "Transform the asset before serving it to the client.\n" + "summary": [ + { + "kind": "text", + "text": "Transform the asset before serving it to the client." + } + ] }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 608, - "character": 45 + "line": 649, + "character": 45, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ], "type": { "type": "reference", - "id": 488, + "id": 518, "name": "TransformOptions", "dereferenced": { - "id": 488, + "id": 518, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 493, + "id": 523, "name": "format", "kind": 1024, "kindString": "Property", @@ -7797,14 +9398,19 @@ "isOptional": true }, "comment": { - "shortText": "Specify the format of the image requested.", - "text": "When using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp.\n" + "summary": [ + { + "kind": "text", + "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 144, - "character": 2 + "line": 157, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L157" } ], "type": { @@ -7813,7 +9419,7 @@ } }, { - "id": 490, + "id": 520, "name": "height", "kind": 1024, "kindString": "Property", @@ -7821,13 +9427,19 @@ "isOptional": true }, "comment": { - "shortText": "The height of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The height of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 + "line": 137, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L137" } ], "type": { @@ -7836,7 +9448,7 @@ } }, { - "id": 492, + "id": 522, "name": "quality", "kind": 1024, "kindString": "Property", @@ -7844,13 +9456,19 @@ "isOptional": true }, "comment": { - "shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + "summary": [ + { + "kind": "text", + "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 137, - "character": 2 + "line": 150, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L150" } ], "type": { @@ -7859,7 +9477,7 @@ } }, { - "id": 491, + "id": 521, "name": "resize", "kind": 1024, "kindString": "Property", @@ -7867,13 +9485,19 @@ "isOptional": true }, "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + "summary": [ + { + "kind": "text", + "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 + "line": 144, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L144" } ], "type": { @@ -7895,7 +9519,7 @@ } }, { - "id": 489, + "id": 519, "name": "width", "kind": 1024, "kindString": "Property", @@ -7903,13 +9527,19 @@ "isOptional": true }, "comment": { - "shortText": "The width of the image in pixels." + "summary": [ + { + "kind": "text", + "text": "The width of the image in pixels." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 + "line": 133, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L133" } ], "type": { @@ -7921,15 +9551,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [493, 490, 492, 491, 489] + "children": [523, 520, 522, 521, 519] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 + "line": 129, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L129" } ] } @@ -7939,8 +9569,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [294, 295] + "children": [300, 301] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 649, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L649" } ] } @@ -7950,14 +9587,14 @@ "type": { "type": "reflection", "declaration": { - "id": 296, + "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 297, + "id": 303, "name": "data", "kind": 1024, "kindString": "Property", @@ -7965,21 +9602,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 7 + "line": 650, + "character": 7, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { "type": "reflection", "declaration": { - "id": 298, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 299, + "id": 305, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -7987,8 +9625,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 609, - "character": 15 + "line": 650, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ], "type": { @@ -8000,19 +9639,33 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [299] + "children": [305] } - ] - } - } - } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" + } + ] + } + } + } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [297] + "children": [303] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 650, + "character": 5, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L650" } ] } @@ -8021,7 +9674,7 @@ ] }, { - "id": 271, + "id": 277, "name": "info", "kind": 2048, "kindString": "Method", @@ -8029,30 +9682,33 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 532, - "character": 8 + "line": 567, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L567" } ], "signatures": [ { - "id": 272, + "id": 278, "name": "info", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves the details of an existing file." + "summary": [ + { + "kind": "text", + "text": "Retrieves the details of an existing file." + } + ] }, "parameters": [ { - "id": 273, + "id": 279, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "\n" - }, "type": { "type": "intrinsic", "name": "string" @@ -8068,14 +9724,14 @@ { "type": "reflection", "declaration": { - "id": 274, + "id": 280, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 275, + "id": 281, "name": "data", "kind": 1024, "kindString": "Property", @@ -8083,17 +9739,18 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 536, - "character": 8 + "line": 571, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L571" } ], "type": { "type": "reference", - "id": 494, + "id": 524, "typeArguments": [ { "type": "reference", - "id": 453, + "id": 472, "name": "FileObjectV2" } ], @@ -8101,7 +9758,7 @@ } }, { - "id": 276, + "id": 282, "name": "error", "kind": 1024, "kindString": "Property", @@ -8109,8 +9766,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 537, - "character": 8 + "line": 572, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L572" } ], "type": { @@ -8122,8 +9780,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [275, 276] + "children": [281, 282] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 570, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L570" } ] } @@ -8131,14 +9796,14 @@ { "type": "reflection", "declaration": { - "id": 277, + "id": 283, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 278, + "id": 284, "name": "data", "kind": 1024, "kindString": "Property", @@ -8146,8 +9811,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 540, - "character": 8 + "line": 575, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L575" } ], "type": { @@ -8156,7 +9822,7 @@ } }, { - "id": 279, + "id": 285, "name": "error", "kind": 1024, "kindString": "Property", @@ -8164,13 +9830,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 541, - "character": 8 + "line": 576, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L576" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8178,8 +9845,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [278, 279] + "children": [284, 285] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 574, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L574" } ] } @@ -8187,15 +9861,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 309, + "id": 315, "name": "list", "kind": 2048, "kindString": "Method", @@ -8203,23 +9877,29 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 741, - "character": 8 + "line": 785, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L785" } ], "signatures": [ { - "id": 310, + "id": 316, "name": "list", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Lists all the files within a bucket." + "summary": [ + { + "kind": "text", + "text": "Lists all the files and folders within a path of the bucket." + } + ] }, "parameters": [ { - "id": 311, + "id": 317, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -8227,7 +9907,12 @@ "isOptional": true }, "comment": { - "shortText": "The folder path." + "summary": [ + { + "kind": "text", + "text": "The folder path." + } + ] }, "type": { "type": "intrinsic", @@ -8235,7 +9920,7 @@ } }, { - "id": 312, + "id": 318, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8243,21 +9928,26 @@ "isOptional": true }, "comment": { - "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search\n" + "summary": [ + { + "kind": "text", + "text": "Search options including limit (defaults to 100), offset, sortBy, and search" + } + ] }, "type": { "type": "reference", - "id": 479, + "id": 498, "name": "SearchOptions", "dereferenced": { - "id": 479, + "id": 498, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 480, + "id": 499, "name": "limit", "kind": 1024, "kindString": "Property", @@ -8265,11 +9955,21 @@ "isOptional": true }, "comment": { - "shortText": "The number of files you want to be returned.", - "tags": [ + "summary": [ { - "tag": "default", - "text": "100\n" + "kind": "text", + "text": "The number of files you want to be returned." + } + ], + "blockTags": [ + { + "tag": "@default", + "content": [ + { + "kind": "text", + "text": "100" + } + ] } ] }, @@ -8277,7 +9977,8 @@ { "fileName": "src/lib/types.ts", "line": 86, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L86" } ], "type": { @@ -8286,7 +9987,7 @@ } }, { - "id": 481, + "id": 500, "name": "offset", "kind": 1024, "kindString": "Property", @@ -8294,13 +9995,19 @@ "isOptional": true }, "comment": { - "shortText": "The starting position." + "summary": [ + { + "kind": "text", + "text": "The starting position." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 91, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L91" } ], "type": { @@ -8309,7 +10016,7 @@ } }, { - "id": 483, + "id": 502, "name": "search", "kind": 1024, "kindString": "Property", @@ -8317,13 +10024,19 @@ "isOptional": true }, "comment": { - "shortText": "The search string to filter files by." + "summary": [ + { + "kind": "text", + "text": "The search string to filter files by." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 101, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L101" } ], "type": { @@ -8332,7 +10045,7 @@ } }, { - "id": 482, + "id": 501, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -8340,28 +10053,34 @@ "isOptional": true }, "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." + "summary": [ + { + "kind": "text", + "text": "The column to sort by. Can be any column inside a FileObject." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 96, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L96" } ], "type": { "type": "reference", - "id": 467, + "id": 486, "name": "SortBy", "dereferenced": { - "id": 467, + "id": 486, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 468, + "id": 487, "name": "column", "kind": 1024, "kindString": "Property", @@ -8372,7 +10091,8 @@ { "fileName": "src/lib/types.ts", "line": 44, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L44" } ], "type": { @@ -8381,7 +10101,7 @@ } }, { - "id": 469, + "id": 488, "name": "order", "kind": 1024, "kindString": "Property", @@ -8392,7 +10112,8 @@ { "fileName": "src/lib/types.ts", "line": 45, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L45" } ], "type": { @@ -8404,15 +10125,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [468, 469] + "children": [487, 488] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 43, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L43" } ] } @@ -8422,22 +10143,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [480, 481, 483, 482] + "children": [499, 500, 502, 501] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 81, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L81" } ] } } }, { - "id": 313, + "id": 319, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -8446,17 +10167,17 @@ }, "type": { "type": "reference", - "id": 484, + "id": 514, "name": "FetchParameters", "dereferenced": { - "id": 484, + "id": 514, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 485, + "id": 515, "name": "signal", "kind": 1024, "kindString": "Property", @@ -8464,35 +10185,41 @@ "isOptional": true }, "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" } ], "type": { "type": "reference", + "name": "AbortSignal", "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [485] + "children": [515] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, - "character": 17 + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" } ] } @@ -8508,14 +10235,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 320, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 321, "name": "data", "kind": 1024, "kindString": "Property", @@ -8523,21 +10250,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 747, - "character": 8 + "line": 791, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L791" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 443, + "id": 462, "name": "FileObject" } } }, { - "id": 316, + "id": 322, "name": "error", "kind": 1024, "kindString": "Property", @@ -8545,8 +10273,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 748, - "character": 8 + "line": 792, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L792" } ], "type": { @@ -8558,8 +10287,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [315, 316] + "children": [321, 322] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 790, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L790" } ] } @@ -8567,14 +10303,14 @@ { "type": "reflection", "declaration": { - "id": 317, + "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 318, + "id": 324, "name": "data", "kind": 1024, "kindString": "Property", @@ -8582,8 +10318,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 751, - "character": 8 + "line": 795, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L795" } ], "type": { @@ -8592,7 +10329,7 @@ } }, { - "id": 319, + "id": 325, "name": "error", "kind": 1024, "kindString": "Property", @@ -8600,13 +10337,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 752, - "character": 8 + "line": 796, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L796" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8614,8 +10352,390 @@ "groups": [ { "title": "Properties", + "children": [324, 325] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 794, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L794" + } + ] + } + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 326, + "name": "listV2", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 826, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L826" + } + ], + "signatures": [ + { + "id": 327, + "name": "listV2", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "this method signature might change in the future" + } + ], + "modifierTags": ["@experimental"] + }, + "parameters": [ + { + "id": 328, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "search options" + } + ] + }, + "type": { + "type": "reference", + "id": 503, + "name": "SearchV2Options", + "dereferenced": { + "id": 503, + "name": "SearchV2Options", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 506, + "name": "cursor", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L107" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 504, + "name": "limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L105" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 505, + "name": "prefix", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L106" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 507, + "name": "with_delimiter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L108" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [506, 504, 505, 507] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L104" + } + ] + } + } + }, + { + "id": 329, + "name": "parameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 514, + "name": "FetchParameters", + "dereferenced": { + "id": 514, + "name": "FetchParameters", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 515, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pass in an AbortController's signal to cancel the request." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L121" + } + ], + "type": { + "type": "reference", + "name": "AbortSignal", + "qualifiedName": "AbortSignal", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [515] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L117" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 330, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 331, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 831, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L831" + } + ], + "type": { + "type": "reference", + "id": 508, + "name": "SearchV2Result" + } + }, + { + "id": 332, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 832, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L832" + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [331, 332] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 830, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L830" + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 333, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 334, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 835, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L835" + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 335, + "name": "error", "kind": 1024, - "children": [318, 319] + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 836, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L836" + } + ], + "type": { + "type": "reference", + "id": 529, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [334, 335] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 834, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L834" } ] } @@ -8623,15 +10743,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 200, + "id": 206, "name": "move", "kind": 2048, "kindString": "Method", @@ -8639,29 +10759,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, - "character": 8 + "line": 332, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L332" } ], "signatures": [ { - "id": 201, + "id": 207, "name": "move", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." + "summary": [ + { + "kind": "text", + "text": "Moves an existing file to a new path in the same bucket." + } + ] }, "parameters": [ { - "id": 202, + "id": 208, "name": "fromPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." + "summary": [ + { + "kind": "text", + "text": "The original file path, including the current file name. For example " + }, + { + "kind": "code", + "text": "`folder/image.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -8669,13 +10808,26 @@ } }, { - "id": 203, + "id": 209, "name": "toPath", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." + "summary": [ + { + "kind": "text", + "text": "The new file path, including the new file name. For example " + }, + { + "kind": "code", + "text": "`folder/image-new.png`" + }, + { + "kind": "text", + "text": "." + } + ] }, "type": { "type": "intrinsic", @@ -8683,7 +10835,7 @@ } }, { - "id": 204, + "id": 210, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8691,21 +10843,26 @@ "isOptional": true }, "comment": { - "shortText": "The destination options.\n" + "summary": [ + { + "kind": "text", + "text": "The destination options." + } + ] }, "type": { "type": "reference", - "id": 477, + "id": 496, "name": "DestinationOptions", "dereferenced": { - "id": 477, + "id": 496, "name": "DestinationOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 478, + "id": 497, "name": "destinationBucket", "kind": 1024, "kindString": "Property", @@ -8716,7 +10873,8 @@ { "fileName": "src/lib/types.ts", "line": 78, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L78" } ], "type": { @@ -8728,15 +10886,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [478] + "children": [497] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 77, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L77" } ] } @@ -8752,14 +10910,14 @@ { "type": "reflection", "declaration": { - "id": 205, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 206, + "id": 212, "name": "data", "kind": 1024, "kindString": "Property", @@ -8767,21 +10925,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 8 + "line": 338, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 208, + "id": 214, "name": "message", "kind": 1024, "kindString": "Property", @@ -8789,8 +10948,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 16 + "line": 338, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ], "type": { @@ -8802,15 +10962,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [208] + "children": [214] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 338, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L338" } ] } } }, { - "id": 209, + "id": 215, "name": "error", "kind": 1024, "kindString": "Property", @@ -8818,8 +10985,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 319, - "character": 8 + "line": 339, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L339" } ], "type": { @@ -8831,8 +10999,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [206, 209] + "children": [212, 215] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 337, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L337" } ] } @@ -8840,14 +11015,14 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 217, "name": "data", "kind": 1024, "kindString": "Property", @@ -8855,8 +11030,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 322, - "character": 8 + "line": 342, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L342" } ], "type": { @@ -8865,7 +11041,7 @@ } }, { - "id": 212, + "id": 218, "name": "error", "kind": 1024, "kindString": "Property", @@ -8873,13 +11049,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 323, - "character": 8 + "line": 343, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L343" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -8887,8 +11064,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [211, 212] + "children": [217, 218] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 341, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L341" } ] } @@ -8896,15 +11080,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 300, + "id": 306, "name": "remove", "kind": 2048, "kindString": "Method", @@ -8912,29 +11096,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 644, - "character": 8 + "line": 685, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L685" } ], "signatures": [ { - "id": 301, + "id": 307, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Deletes files within the same bucket" + "summary": [ + { + "kind": "text", + "text": "Deletes files within the same bucket" + } + ] }, "parameters": [ { - "id": 302, + "id": 308, "name": "paths", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" + "summary": [ + { + "kind": "text", + "text": "An array of files to delete, including the path and file name. For example [" + }, + { + "kind": "code", + "text": "`'folder/image.png'`" + }, + { + "kind": "text", + "text": "]." + } + ] }, "type": { "type": "array", @@ -8954,14 +11157,14 @@ { "type": "reflection", "declaration": { - "id": 303, + "id": 309, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 304, + "id": 310, "name": "data", "kind": 1024, "kindString": "Property", @@ -8969,21 +11172,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 648, - "character": 8 + "line": 689, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L689" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 443, + "id": 462, "name": "FileObject" } } }, { - "id": 305, + "id": 311, "name": "error", "kind": 1024, "kindString": "Property", @@ -8991,8 +11195,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 649, - "character": 8 + "line": 690, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L690" } ], "type": { @@ -9004,8 +11209,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [304, 305] + "children": [310, 311] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 688, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L688" } ] } @@ -9013,14 +11225,14 @@ { "type": "reflection", "declaration": { - "id": 306, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 307, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -9028,8 +11240,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 652, - "character": 8 + "line": 693, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L693" } ], "type": { @@ -9038,7 +11251,7 @@ } }, { - "id": 308, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -9046,13 +11259,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, - "character": 8 + "line": 694, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L694" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -9060,8 +11274,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [307, 308] + "children": [313, 314] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 692, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L692" } ] } @@ -9069,15 +11290,54 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 323, + "id": 127, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 66, + "character": 9, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L66" + } + ], + "signatures": [ + { + "id": 128, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Enable throwing errors instead of returning them." + } + ] + }, + "type": { + "type": "reference", + "id": 101, + "name": "default" + } + } + ] + }, + { + "id": 339, "name": "toBase64", "kind": 2048, "kindString": "Method", @@ -9085,20 +11345,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 778, - "character": 2 + "line": 865, + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L865" } ], "signatures": [ { - "id": 324, + "id": 340, "name": "toBase64", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 325, + "id": 341, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -9117,7 +11378,7 @@ ] }, { - "id": 185, + "id": 191, "name": "update", "kind": 2048, "kindString": "Method", @@ -9125,29 +11386,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 278, - "character": 8 + "line": 298, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L298" } ], "signatures": [ { - "id": 186, + "id": 192, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." + "summary": [ + { + "kind": "text", + "text": "Replaces an existing file at the specified path with a new one." + } + ] }, "parameters": [ { - "id": 187, + "id": 193, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." + "summary": [ + { + "kind": "text", + "text": "The relative file path. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to update." + } + ] }, "type": { "type": "intrinsic", @@ -9155,13 +11435,18 @@ } }, { - "id": 188, + "id": 194, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "union", @@ -9172,71 +11457,71 @@ }, { "type": "reference", + "name": "ArrayBuffer", "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" + "package": "typescript" }, { "type": "reference", + "name": "ArrayBufferView", "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" + "package": "typescript" }, { "type": "reference", + "name": "Blob", "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" + "package": "typescript" }, { "type": "reference", + "name": "Buffer", "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" + "package": "@types/node" }, { "type": "reference", + "name": "File", "qualifiedName": "File", - "package": "typescript", - "name": "File" + "package": "typescript" }, { "type": "reference", + "name": "FormData", "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" + "package": "typescript" }, { "type": "reference", + "name": "ReadableStream", "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" + "package": "@types/node" }, { "type": "reference", "typeArguments": [ { "type": "reference", + "name": "Uint8Array", "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" + "package": "typescript" } ], + "name": "ReadableStream", "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" + "package": "typescript" }, { "type": "reference", + "name": "URLSearchParams", "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" + "package": "typescript" } ] } }, { - "id": 189, + "id": 195, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -9245,17 +11530,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -9263,13 +11548,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -9278,7 +11577,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -9286,13 +11585,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -9301,7 +11654,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -9309,13 +11662,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -9324,7 +11683,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9332,13 +11691,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -9353,13 +11718,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -9367,13 +11732,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -9388,13 +11759,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -9402,13 +11773,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -9420,15 +11797,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -9444,14 +11821,14 @@ { "type": "reflection", "declaration": { - "id": 190, + "id": 196, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 191, + "id": 197, "name": "data", "kind": 1024, "kindString": "Property", @@ -9459,21 +11836,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 8 + "line": 314, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { "type": "reflection", "declaration": { - "id": 192, + "id": 198, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 201, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -9481,8 +11859,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 42 + "line": 314, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -9491,7 +11870,7 @@ } }, { - "id": 193, + "id": 199, "name": "id", "kind": 1024, "kindString": "Property", @@ -9499,8 +11878,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 16 + "line": 314, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -9509,7 +11889,7 @@ } }, { - "id": 194, + "id": 200, "name": "path", "kind": 1024, "kindString": "Property", @@ -9517,8 +11897,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 294, - "character": 28 + "line": 314, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ], "type": { @@ -9530,15 +11911,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [195, 193, 194] + "children": [201, 199, 200] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 314, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L314" } ] } } }, { - "id": 196, + "id": 202, "name": "error", "kind": 1024, "kindString": "Property", @@ -9546,8 +11934,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 295, - "character": 8 + "line": 315, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L315" } ], "type": { @@ -9559,8 +11948,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [191, 196] + "children": [197, 202] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 313, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L313" } ] } @@ -9568,14 +11964,14 @@ { "type": "reflection", "declaration": { - "id": 197, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -9583,8 +11979,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 298, - "character": 8 + "line": 318, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L318" } ], "type": { @@ -9593,7 +11990,7 @@ } }, { - "id": 199, + "id": 205, "name": "error", "kind": 1024, "kindString": "Property", @@ -9601,13 +11998,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 299, - "character": 8 + "line": 319, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L319" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -9615,8 +12013,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [198, 199] + "children": [204, 205] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L317" } ] } @@ -9624,15 +12029,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 139, + "id": 145, "name": "upload", "kind": 2048, "kindString": "Method", @@ -9640,29 +12045,48 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 147, - "character": 8 + "line": 161, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L161" } ], "signatures": [ { - "id": 140, + "id": 146, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Uploads a file to an existing bucket." + "summary": [ + { + "kind": "text", + "text": "Uploads a file to an existing bucket." + } + ] }, "parameters": [ { - "id": 141, + "id": 147, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -9670,13 +12094,18 @@ } }, { - "id": 142, + "id": 148, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -9684,7 +12113,7 @@ } }, { - "id": 143, + "id": 149, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -9693,17 +12122,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -9711,13 +12140,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -9726,7 +12169,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -9734,13 +12177,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -9749,7 +12246,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -9757,13 +12254,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -9772,7 +12275,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9780,13 +12283,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -9801,13 +12310,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -9815,13 +12324,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -9836,13 +12351,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -9850,13 +12365,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -9868,15 +12389,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -9892,14 +12413,14 @@ { "type": "reflection", "declaration": { - "id": 144, + "id": 150, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 145, + "id": 151, "name": "data", "kind": 1024, "kindString": "Property", @@ -9907,21 +12428,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 8 + "line": 167, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { "type": "reflection", "declaration": { - "id": 146, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 149, + "id": 155, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -9929,8 +12451,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 42 + "line": 167, + "character": 42, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -9939,7 +12462,7 @@ } }, { - "id": 147, + "id": 153, "name": "id", "kind": 1024, "kindString": "Property", @@ -9947,8 +12470,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 16 + "line": 167, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -9957,7 +12481,7 @@ } }, { - "id": 148, + "id": 154, "name": "path", "kind": 1024, "kindString": "Property", @@ -9965,8 +12489,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 153, - "character": 28 + "line": 167, + "character": 28, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ], "type": { @@ -9978,15 +12503,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [149, 147, 148] + "children": [155, 153, 154] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 167, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L167" } ] } } }, { - "id": 150, + "id": 156, "name": "error", "kind": 1024, "kindString": "Property", @@ -9994,8 +12526,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 154, - "character": 8 + "line": 168, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L168" } ], "type": { @@ -10007,8 +12540,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [145, 150] + "children": [151, 156] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 166, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L166" } ] } @@ -10016,14 +12556,14 @@ { "type": "reflection", "declaration": { - "id": 151, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 158, "name": "data", "kind": 1024, "kindString": "Property", @@ -10031,8 +12571,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 157, - "character": 8 + "line": 171, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L171" } ], "type": { @@ -10041,7 +12582,7 @@ } }, { - "id": 153, + "id": 159, "name": "error", "kind": 1024, "kindString": "Property", @@ -10049,13 +12590,14 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, - "character": 8 + "line": 172, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L172" } ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -10063,8 +12605,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [152, 153] + "children": [158, 159] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 170, + "character": 6, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L170" } ] } @@ -10072,15 +12621,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 154, + "id": 160, "name": "uploadToSignedUrl", "kind": 2048, "kindString": "Method", @@ -10088,29 +12637,56 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 170, - "character": 8 + "line": 184, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L184" } ], "signatures": [ { - "id": 155, + "id": 161, "name": "uploadToSignedUrl", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Upload a file with a token generated from `createSignedUploadUrl`." + "summary": [ + { + "kind": "text", + "text": "Upload a file with a token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + }, + { + "kind": "text", + "text": "." + } + ] }, "parameters": [ { - "id": 156, + "id": 162, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + "summary": [ + { + "kind": "text", + "text": "The file path, including the file name. Should be of the format " + }, + { + "kind": "code", + "text": "`folder/subfolder/filename.png`" + }, + { + "kind": "text", + "text": ". The bucket must already exist before attempting to upload." + } + ] }, "type": { "type": "intrinsic", @@ -10118,13 +12694,22 @@ } }, { - "id": 157, + "id": 163, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The token generated from `createSignedUploadUrl`" + "summary": [ + { + "kind": "text", + "text": "The token generated from " + }, + { + "kind": "code", + "text": "`createSignedUploadUrl`" + } + ] }, "type": { "type": "intrinsic", @@ -10132,13 +12717,18 @@ } }, { - "id": 158, + "id": 164, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" + "summary": [ + { + "kind": "text", + "text": "The body of the file to be stored in the bucket." + } + ] }, "type": { "type": "reference", @@ -10146,7 +12736,7 @@ } }, { - "id": 159, + "id": 165, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -10155,17 +12745,17 @@ }, "type": { "type": "reference", - "id": 470, + "id": 489, "name": "FileOptions", "dereferenced": { - "id": 470, + "id": 489, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 471, + "id": 490, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -10173,13 +12763,27 @@ "isOptional": true }, "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + "summary": [ + { + "kind": "text", + "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " + }, + { + "kind": "code", + "text": "`Cache-Control: max-age=`" + }, + { + "kind": "text", + "text": " header. Defaults to 3600 seconds." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 52, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L52" } ], "type": { @@ -10188,7 +12792,7 @@ } }, { - "id": 472, + "id": 491, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -10196,13 +12800,67 @@ "isOptional": true }, "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + "summary": [ + { + "kind": "text", + "text": "the " + }, + { + "kind": "code", + "text": "`Content-Type`" + }, + { + "kind": "text", + "text": " header value. Should be specified if using a " + }, + { + "kind": "code", + "text": "`fileBody`" + }, + { + "kind": "text", + "text": " that is neither " + }, + { + "kind": "code", + "text": "`Blob`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`File`" + }, + { + "kind": "text", + "text": " nor " + }, + { + "kind": "code", + "text": "`FormData`" + }, + { + "kind": "text", + "text": ", otherwise will default to " + }, + { + "kind": "code", + "text": "`text/plain;charset=UTF-8`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 56, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L56" } ], "type": { @@ -10211,7 +12869,7 @@ } }, { - "id": 474, + "id": 493, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -10219,13 +12877,19 @@ "isOptional": true }, "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + "summary": [ + { + "kind": "text", + "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 64, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L64" } ], "type": { @@ -10234,7 +12898,7 @@ } }, { - "id": 476, + "id": 495, "name": "headers", "kind": 1024, "kindString": "Property", @@ -10242,13 +12906,19 @@ "isOptional": true }, "comment": { - "shortText": "Optionally add extra headers" + "summary": [ + { + "kind": "text", + "text": "Optionally add extra headers" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 74, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L74" } ], "type": { @@ -10263,13 +12933,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 475, + "id": 494, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -10277,13 +12947,19 @@ "isOptional": true }, "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + "summary": [ + { + "kind": "text", + "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 69, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L69" } ], "type": { @@ -10298,13 +12974,13 @@ "name": "any" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 473, + "id": 492, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -10312,13 +12988,19 @@ "isOptional": true }, "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + "summary": [ + { + "kind": "text", + "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", "line": 60, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L60" } ], "type": { @@ -10330,15 +13012,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [471, 472, 474, 476, 475, 473] + "children": [490, 491, 493, 495, 494, 492] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 48, - "character": 17 + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/lib/types.ts#L48" } ] } @@ -10354,14 +13036,14 @@ { "type": "reflection", "declaration": { - "id": 160, + "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 161, + "id": 167, "name": "data", "kind": 1024, "kindString": "Property", @@ -10369,21 +13051,22 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 8 + "line": 220, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { "type": "reflection", "declaration": { - "id": 162, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 164, + "id": 170, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -10391,8 +13074,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 33 + "line": 220, + "character": 33, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -10402,7 +13086,7 @@ "defaultValue": "data.Key" }, { - "id": 163, + "id": 169, "name": "path", "kind": 1024, "kindString": "Property", @@ -10410,8 +13094,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, - "character": 16 + "line": 220, + "character": 16, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ], "type": { @@ -10424,8 +13109,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [164, 163] + "children": [170, 169] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 220, + "character": 14, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L220" } ] } @@ -10433,7 +13125,7 @@ "defaultValue": "..." }, { - "id": 165, + "id": 171, "name": "error", "kind": 1024, "kindString": "Property", @@ -10441,8 +13133,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 207, - "character": 8 + "line": 221, + "character": 8, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L221" } ], "type": { @@ -10455,8 +13148,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [161, 165] + "children": [167, 171] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 219, + "character": 13, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L219" } ] } @@ -10464,14 +13164,14 @@ { "type": "reflection", "declaration": { - "id": 166, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 167, + "id": 173, "name": "data", "kind": 1024, "kindString": "Property", @@ -10479,8 +13179,9 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 211, - "character": 17 + "line": 228, + "character": 17, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ], "type": { @@ -10490,14 +13191,22 @@ "defaultValue": "null" }, { - "id": 168, + "id": 174, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 29, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" + } + ], "type": { "type": "reference", - "id": 499, + "id": 529, "name": "StorageError" } } @@ -10505,8 +13214,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [167, 168] + "children": [173, 174] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 228, + "character": 15, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L228" } ] } @@ -10514,9 +13230,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -10525,22 +13241,21 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [99] + "children": [102] }, { "title": "Methods", - "kind": 2048, "children": [ - 213, 169, 226, 242, 259, 280, 289, 271, 309, 200, 300, 323, 185, 139, 154 + 219, 175, 232, 248, 265, 286, 295, 277, 315, 326, 206, 306, 127, 339, 191, 145, 160 ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 42, - "character": 21 + "line": 44, + "character": 21, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L44" } ] } @@ -10548,15 +13263,15 @@ "groups": [ { "title": "Classes", - "kind": 128, - "children": [98] + "children": [101] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/storage-js/blob/ae7bbb0/src/packages/StorageFileApi.ts#L1" } ] } @@ -10564,8 +13279,7 @@ "groups": [ { "title": "Modules", - "kind": 2, - "children": [1, 2, 97] + "children": [1, 2, 100] } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase.json index def4b60e285ba..e00841b8170f3 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/supabase.json @@ -13,78 +13,86 @@ "flags": {}, "children": [ { - "id": 227, + "id": 270, "name": "QueryData", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 123 + "target": 139 }, { - "id": 228, + "id": 271, "name": "QueryError", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 61 + "character": 61, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 127 + "target": 143 }, { - "id": 226, + "id": 269, "name": "QueryResult", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 121 + "target": 137 }, { - "id": 225, + "id": 268, "name": "SupabaseClientOptions", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 70 + "target": 83 }, { - "id": 130, + "id": 146, "name": "SupabaseClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" + "summary": [ + { + "kind": "text", + "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." + } + ] }, "children": [ { - "id": 131, + "id": 147, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -92,23 +100,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 70, - "character": 2 + "line": 99, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L99" } ], "signatures": [ { - "id": 132, + "id": 148, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Create a new client for use in the browser." + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] }, "typeParameter": [ { - "id": 133, + "id": 149, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -119,14 +133,64 @@ } }, { - "id": 134, - "name": "SchemaName", + "id": 152, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 151, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [151] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] + } + } + ] }, "default": { "type": "conditional", @@ -135,13 +199,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -155,27 +231,166 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } + } + }, + { + "id": 153, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } } } }, { - "id": 135, + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "default": { @@ -184,18 +399,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -211,80 +438,401 @@ }, "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" } } - } - ], - "parameters": [ - { - "id": 136, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } }, { - "id": 137, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", + "id": 165, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 138, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, "type": { - "type": "reference", - "id": 70, - "typeArguments": [ - { - "type": "reference", - "id": 134, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 130, - "typeArguments": [ - { - "type": "reference", - "id": 133, - "name": "Database" - }, - { - "type": "reference", - "id": 134, - "name": "SchemaName" + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [156] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } }, - { + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 149, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 157, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 158, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 160, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [160] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [158] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 162, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [162] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 164, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [164] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + ], + "parameters": [ + { + "id": 166, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 167, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 168, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 83, + "typeArguments": [ + { + "type": "reference", + "id": 153, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 146, + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + { "type": "reference", - "id": 135, + "id": 153, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 154, "name": "Schema" + }, + { + "type": "reference", + "id": 165, + "name": "ClientOptions" } ], "name": "default" @@ -293,7 +841,7 @@ ] }, { - "id": 153, + "id": 184, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -304,21 +852,30 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 54, - "character": 12 + "line": 82, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" } ], "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 82, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" + } + ], "signatures": [ { - "id": 155, + "id": 186, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -340,9 +897,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -350,19 +907,25 @@ } }, { - "id": 139, + "id": 169, "name": "auth", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + "summary": [ + { + "kind": "text", + "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 43, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L67" } ], "type": { @@ -371,7 +934,7 @@ } }, { - "id": 142, + "id": 173, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -381,19 +944,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 47, - "character": 12 + "line": 75, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L75" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 152, + "id": 183, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -404,8 +968,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 53, - "character": 12 + "line": 81, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L81" } ], "type": { @@ -414,7 +979,7 @@ } }, { - "id": 147, + "id": 178, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -425,28 +990,36 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 52, - "character": 12 + "line": 80, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 148, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 149, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 150, + "id": 181, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -456,21 +1029,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 151, + "id": 182, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -479,9 +1052,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -490,14 +1063,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -505,7 +1078,7 @@ } }, { - "id": 144, + "id": 175, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -515,19 +1088,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 49, - "character": 12 + "line": 77, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L77" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 156, + "id": 187, "name": "headers", "kind": 1024, "kindString": "Property", @@ -537,8 +1111,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 12 + "line": 84, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L84" } ], "type": { @@ -553,13 +1128,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 140, + "id": 170, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -567,19 +1142,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 44, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L68" } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } }, { - "id": 141, + "id": 172, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -589,19 +1165,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 46, - "character": 12 + "line": 74, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L74" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 145, + "id": 176, "name": "rest", "kind": 1024, "kindString": "Property", @@ -611,8 +1188,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 50, - "character": 12 + "line": 78, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L78" } ], "type": { @@ -620,38 +1198,117 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 134, - "name": "SchemaName" + "id": 165, + "name": "ClientOptions" }, { "type": "reference", - "id": 135, - "name": "Schema" + "id": 153, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } }, { - "id": 146, - "name": "storageKey", + "id": 171, + "name": "storage", "kind": 1024, "kindString": "Property", - "flags": { - "isProtected": true + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 51, - "character": 12 + "line": 72, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L72" + } + ], + "type": { + "type": "reference", + "name": "StorageClient", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js" + } + }, + { + "id": 177, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 79, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L79" } ], "type": { @@ -660,7 +1317,7 @@ } }, { - "id": 143, + "id": 174, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -670,109 +1327,114 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 48, - "character": 12 + "line": 76, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L76" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 158, + "id": 189, "name": "supabaseKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 101, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L101" + } + ], "type": { "type": "intrinsic", "name": "string" } }, { - "id": 157, + "id": 188, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 159, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] + }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 141, - "character": 6 + "line": 100, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L100" } ], - "getSignature": [ - { - "id": 160, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 161, - "name": "storage", + "id": 190, + "name": "functions", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 151, - "character": 6 + "line": 174, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L174" } ], - "getSignature": [ - { - "id": 162, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } + "getSignature": { + "id": 191, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Functions allows you to deploy and invoke edge functions." + } + ] + }, + "type": { + "type": "reference", + "name": "FunctionsClient", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js" } - ] + } }, { - "id": 200, + "id": 229, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -782,13 +1444,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 271, - "character": 16 + "line": 300, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L300" } ], "signatures": [ { - "id": 201, + "id": 230, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -810,15 +1473,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 217, + "id": 246, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -828,33 +1491,34 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 331, - "character": 10 + "line": 364, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L364" } ], "signatures": [ { - "id": 218, + "id": 247, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 248, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "AuthChangeEvent", "qualifiedName": "AuthChangeEvent", - "package": "@supabase/auth-js", - "name": "AuthChangeEvent" + "package": "@supabase/auth-js" } }, { - "id": 220, + "id": 249, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -874,7 +1538,7 @@ } }, { - "id": 221, + "id": 250, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -895,7 +1559,7 @@ ] }, { - "id": 211, + "id": 240, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -905,43 +1569,44 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 317, - "character": 10 + "line": 350, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L350" } ], "signatures": [ { - "id": 212, + "id": 241, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 242, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 202, + "id": 231, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -951,32 +1616,33 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 281, - "character": 10 + "line": 310, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L310" } ], "signatures": [ { - "id": 203, + "id": 232, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 204, + "id": 233, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } }, { - "id": 205, + "id": 234, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -995,13 +1661,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 206, + "id": 235, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -1011,21 +1677,28 @@ "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 208, + "id": 237, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 209, + "id": 238, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1035,21 +1708,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 210, + "id": 239, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1058,9 +1731,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -1069,14 +1742,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -1092,7 +1765,7 @@ ] }, { - "id": 214, + "id": 243, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1102,13 +1775,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 324, - "character": 10 + "line": 357, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L357" } ], "signatures": [ { - "id": 215, + "id": 244, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1116,18 +1790,25 @@ "type": { "type": "reflection", "declaration": { - "id": 216, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/auth-js/dist/module/GoTrueClient.d.ts", + "line": 313, + "character": 108 + } + ] } } } ] }, { - "id": 189, + "id": 218, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1135,29 +1816,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 243, - "character": 2 + "line": 272, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L272" } ], "signatures": [ { - "id": 190, + "id": 219, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + "summary": [ + { + "kind": "text", + "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + } + ] }, "parameters": [ { - "id": 191, + "id": 220, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel." + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "intrinsic", @@ -1165,34 +1857,39 @@ } }, { - "id": 192, + "id": 221, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The options to pass to the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "RealtimeChannelOptions", "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 163, + "id": 192, "name": "from", "kind": 2048, "kindString": "Method", @@ -1200,23 +1897,41 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 156, - "character": 2 + "line": 182, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L182" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 186, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L186" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 194, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L194" } ], "signatures": [ { - "id": 164, + "id": 193, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 165, + "id": 194, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1227,31 +1942,36 @@ } }, { - "id": 166, + "id": 195, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } } ], "parameters": [ { - "id": 167, + "id": 196, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 165, + "id": 194, "name": "TableName" } } @@ -1261,41 +1981,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, { "type": "reference", - "id": 165, + "id": 194, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 168, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -1303,23 +2035,28 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } }, { - "id": 169, + "id": 198, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 170, + "id": 199, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1330,31 +2067,36 @@ } }, { - "id": 171, + "id": 200, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 111, + "id": 127, "name": "GenericView" } } ], "parameters": [ { - "id": 172, + "id": 201, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName" } } @@ -1364,41 +2106,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 173, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -1406,15 +2160,15 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 193, + "id": 222, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -1422,34 +2176,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 250, - "character": 2 + "line": 279, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L279" } ], "signatures": [ { - "id": 194, + "id": 223, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all Realtime channels." + "summary": [ + { + "kind": "text", + "text": "Returns all Realtime channels." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } } ] }, { - "id": 198, + "id": 227, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -1457,19 +2217,25 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 267, - "character": 2 + "line": 296, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L296" } ], "signatures": [ { - "id": 199, + "id": 228, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all Realtime channels from Realtime client." + } + ] }, "type": { "type": "reference", @@ -1495,15 +2261,15 @@ } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 195, + "id": 224, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -1511,35 +2277,46 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 260, - "character": 2 + "line": 289, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L289" } ], "signatures": [ { - "id": 196, + "id": 225, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes Realtime channel from Realtime client." + } + ] }, "parameters": [ { - "id": 197, + "id": 226, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ], @@ -1564,15 +2341,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 178, + "id": 207, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1580,23 +2357,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 214, - "character": 2 + "line": 241, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L241" } ], "signatures": [ { - "id": 179, + "id": 208, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 180, + "id": 209, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -1607,42 +2390,52 @@ } }, { - "id": 181, + "id": 210, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 112, + "id": 128, "name": "GenericFunction" } } ], "parameters": [ { - "id": 182, + "id": 211, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 180, + "id": 209, "name": "FnName" } }, { - "id": 183, + "id": 212, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -1652,32 +2445,37 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 184, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 188, + "id": 217, "name": "count", "kind": 1024, "kindString": "Property", @@ -1685,13 +2483,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 220, - "character": 6 + "line": 247, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L247" } ], "type": { @@ -1713,7 +2549,7 @@ } }, { - "id": 187, + "id": 216, "name": "get", "kind": 1024, "kindString": "Property", @@ -1721,13 +2557,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 219, - "character": 6 + "line": 246, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L246" } ], "type": { @@ -1736,7 +2586,7 @@ } }, { - "id": 186, + "id": 215, "name": "head", "kind": 1024, "kindString": "Property", @@ -1744,13 +2594,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, - "character": 6 + "line": 245, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L245" } ], "type": { @@ -1762,8 +2634,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [188, 187, 186] + "children": [217, 216, 215] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 244, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L244" } ] } @@ -1776,7 +2655,12 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { @@ -1789,7 +2673,7 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, @@ -1832,9 +2716,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -1865,29 +2749,33 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, { "type": "reference", - "id": 180, + "id": 209, "name": "FnName" }, { "type": "literal", "value": null + }, + { + "type": "literal", + "value": "RPC" } ], + "name": "default", "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 174, + "id": 203, "name": "schema", "kind": 2048, "kindString": "Method", @@ -1895,24 +2783,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 180, - "character": 2 + "line": 206, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L206" } ], "signatures": [ { - "id": 175, + "id": 204, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 176, + "id": 205, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -1925,17 +2818,22 @@ ], "parameters": [ { - "id": 177, + "id": 206, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema" } } @@ -1945,12 +2843,17 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 176, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 205, "name": "DynamicSchema" }, { @@ -1959,18 +2862,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 133, + "id": 149, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -1990,9 +2893,9 @@ } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] @@ -2001,35 +2904,34 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [131] + "children": [147] }, { "title": "Properties", - "kind": 1024, - "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] + "children": [ + 184, 169, 173, 183, 178, 175, 187, 170, 172, 176, 171, 177, 174, 189, 188 + ] }, { "title": "Accessors", - "kind": 262144, - "children": [159, 161] + "children": [190] }, { "title": "Methods", - "kind": 2048, - "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] + "children": [229, 246, 240, 231, 243, 218, 192, 222, 227, 224, 207, 203] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 31, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L31" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 222, + "id": 251, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2040,25 +2942,87 @@ } }, { - "id": 223, - "name": "SchemaName", + "id": 254, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intersection", + "type": "union", "types": [ { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + { + "type": "reflection", + "declaration": { + "id": 252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 253, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [253] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] } } ] @@ -2074,8 +3038,20 @@ "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { @@ -2094,8 +3070,20 @@ "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] @@ -2103,254 +3091,1248 @@ } }, { - "id": 224, - "name": "Schema", + "id": 255, + "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "id": 116, - "name": "GenericSchema" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] }, "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "trueType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + } + } + } + }, + { + "id": 256, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" } - } - } - ] - }, - { - "id": 2, - "name": "createClient", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 27, - "character": 13 - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Supabase Client." }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + }, + { + "id": 267, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 257, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 258, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [258] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 149, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 259, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 260, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 261, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 262, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [262] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [260] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 263, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 264, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [264] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 265, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 266, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [266] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + ] + }, + { + "id": 2, + "name": "createClient", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 27, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L27" + } + ], + "signatures": [ + { + "id": 3, + "name": "createClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates a new Supabase Client." + } + ] + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 7, + "name": "SchemaNameOrClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 6, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [6] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ] + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } + } + }, + { + "id": 8, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { "type": "conditional", "checkType": { - "type": "literal", - "value": "public" + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } + } + } + } + ], + "parameters": [ + { + "id": 9, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 10, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 11, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 83, + "typeArguments": [ + { + "type": "reference", + "id": 8, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 146, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { "type": "reference", "id": 4, "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 14, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 15, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [15] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [13] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 17, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [17] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } } }, - "trueType": { - "type": "literal", - "value": "public" - }, "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 116, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 5, - "name": "SchemaName" + "id": 7, + "name": "SchemaNameOrClientOptions" }, - "objectType": { + "extendsType": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 19, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [19] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 116, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" + "name": "SchemaNameOrClientOptions" }, - "objectType": { + "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" } - }, - "falseType": { - "type": "intrinsic", - "name": "any" } } - } - ], - "parameters": [ - { - "id": 7, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 9, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 70, - "typeArguments": [ - { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 130, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } ], "name": "default" } @@ -2361,17 +4343,14 @@ "groups": [ { "title": "References", - "kind": 16777216, - "children": [227, 228, 226, 225] + "children": [270, 271, 269, 268] }, { "title": "Classes", - "kind": 128, - "children": [130] + "children": [146] }, { "title": "Functions", - "kind": 64, "children": [2] } ], @@ -2379,19 +4358,20 @@ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L1" } ] }, { - "id": 10, + "id": 20, "name": "lib/constants", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 22, + "id": 32, "name": "DEFAULT_AUTH_OPTIONS", "kind": 32, "kindString": "Variable", @@ -2402,18 +4382,19 @@ { "fileName": "src/lib/constants.ts", "line": 28, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L28" } ], "type": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" }, "defaultValue": "..." }, { - "id": 19, + "id": 29, "name": "DEFAULT_DB_OPTIONS", "kind": 32, "kindString": "Variable", @@ -2424,20 +4405,21 @@ { "fileName": "src/lib/constants.ts", "line": 24, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ], "type": { "type": "reflection", "declaration": { - "id": 20, + "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 21, + "id": 31, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2446,7 +4428,8 @@ { "fileName": "src/lib/constants.ts", "line": 25, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L25" } ], "type": { @@ -2459,8 +4442,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [21] + "children": [31] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 24, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ] } @@ -2468,7 +4458,7 @@ "defaultValue": "..." }, { - "id": 14, + "id": 24, "name": "DEFAULT_GLOBAL_OPTIONS", "kind": 32, "kindString": "Variable", @@ -2479,20 +4469,21 @@ { "fileName": "src/lib/constants.ts", "line": 20, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 15, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 16, + "id": 26, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2501,20 +4492,21 @@ { "fileName": "src/lib/constants.ts", "line": 21, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L21" } ], "type": { "type": "reflection", "declaration": { - "id": 17, + "id": 27, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 18, + "id": 28, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", @@ -2523,7 +4515,8 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { @@ -2536,8 +4529,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [18] + "children": [28] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ] } @@ -2548,8 +4548,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [16] + "children": [26] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 20, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ] } @@ -2557,7 +4564,7 @@ "defaultValue": "..." }, { - "id": 11, + "id": 21, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", @@ -2568,20 +4575,21 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { "type": "reflection", "declaration": { - "id": 12, + "id": 22, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 13, + "id": 23, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", @@ -2590,7 +4598,8 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { @@ -2603,8 +4612,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [13] + "children": [23] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ] } @@ -2612,7 +4628,7 @@ "defaultValue": "..." }, { - "id": 23, + "id": 33, "name": "DEFAULT_REALTIME_OPTIONS", "kind": 32, "kindString": "Variable", @@ -2623,14 +4639,15 @@ { "fileName": "src/lib/constants.ts", "line": 35, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L35" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" }, "defaultValue": "{}" } @@ -2638,27 +4655,27 @@ "groups": [ { "title": "Variables", - "kind": 32, - "children": [22, 19, 14, 11, 23] + "children": [32, 29, 24, 21, 33] } ], "sources": [ { "fileName": "src/lib/constants.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L2" } ] }, { - "id": 24, + "id": 34, "name": "lib/fetch", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 38, + "id": 48, "name": "fetchWithAuth", "kind": 64, "kindString": "Function", @@ -2667,19 +4684,20 @@ { "fileName": "src/lib/fetch.ts", "line": 26, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L26" } ], "signatures": [ { - "id": 39, + "id": 49, "name": "fetchWithAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 40, + "id": 50, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -2690,7 +4708,7 @@ } }, { - "id": 41, + "id": 51, "name": "getAccessToken", "kind": 32768, "kindString": "Parameter", @@ -2698,14 +4716,22 @@ "type": { "type": "reflection", "declaration": { - "id": 42, + "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 28, + "character": 18, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L28" + } + ], "signatures": [ { - "id": 43, + "id": 53, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -2727,9 +4753,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2737,7 +4763,7 @@ } }, { - "id": 44, + "id": 54, "name": "customFetch", "kind": 32768, "kindString": "Parameter", @@ -2747,21 +4773,28 @@ "type": { "type": "reflection", "declaration": { - "id": 45, + "id": 55, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 46, + "id": 56, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 47, + "id": 57, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2771,21 +4804,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 48, + "id": 58, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2794,9 +4827,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2805,14 +4838,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2823,21 +4856,28 @@ "type": { "type": "reflection", "declaration": { - "id": 49, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 50, + "id": 60, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 51, + "id": 61, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2847,21 +4887,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 52, + "id": 62, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2870,9 +4910,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2881,14 +4921,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -2898,7 +4938,7 @@ ] }, { - "id": 25, + "id": 35, "name": "resolveFetch", "kind": 64, "kindString": "Function", @@ -2907,19 +4947,20 @@ { "fileName": "src/lib/fetch.ts", "line": 6, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L6" } ], "signatures": [ { - "id": 26, + "id": 36, "name": "resolveFetch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 27, + "id": 37, "name": "customFetch", "kind": 32768, "kindString": "Parameter", @@ -2929,21 +4970,28 @@ "type": { "type": "reflection", "declaration": { - "id": 28, + "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 29, + "id": 39, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 30, + "id": 40, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2953,21 +5001,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 31, + "id": 41, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2976,9 +5024,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -2987,14 +5035,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3005,21 +5053,28 @@ "type": { "type": "reflection", "declaration": { - "id": 32, + "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 33, + "id": 43, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 34, + "id": 44, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3029,21 +5084,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 35, + "id": 45, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3052,9 +5107,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3063,14 +5118,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3080,7 +5135,7 @@ ] }, { - "id": 36, + "id": 46, "name": "resolveHeadersConstructor", "kind": 64, "kindString": "Function", @@ -3089,12 +5144,13 @@ { "fileName": "src/lib/fetch.ts", "line": 18, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L18" } ], "signatures": [ { - "id": 37, + "id": 47, "name": "resolveHeadersConstructor", "kind": 4096, "kindString": "Call signature", @@ -3110,27 +5166,27 @@ "groups": [ { "title": "Functions", - "kind": 64, - "children": [38, 25, 36] + "children": [48, 35, 46] } ], "sources": [ { "fileName": "src/lib/fetch.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L2" } ] }, { - "id": 53, + "id": 63, "name": "lib/helpers", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 59, + "id": 69, "name": "applySettingDefaults", "kind": 64, "kindString": "Function", @@ -3139,19 +5195,20 @@ { "fileName": "src/lib/helpers.ts", "line": 18, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L18" } ], "signatures": [ { - "id": 60, + "id": 70, "name": "applySettingDefaults", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 61, + "id": 71, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -3162,7 +5219,7 @@ } }, { - "id": 62, + "id": 72, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -3182,7 +5239,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 61, + "id": 71, "name": "Database" } }, @@ -3202,7 +5259,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 61, + "id": 71, "name": "Database" } } @@ -3213,18 +5270,18 @@ ], "parameters": [ { - "id": 63, + "id": 73, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 62, + "id": 72, "name": "SchemaName" } ], @@ -3232,14 +5289,14 @@ } }, { - "id": 64, + "id": 74, "name": "defaults", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "intrinsic", @@ -3255,26 +5312,26 @@ "typeArguments": [ { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 62, + "id": 72, "name": "SchemaName" } ], "name": "SupabaseClientOptions" } ], + "name": "Required", "qualifiedName": "Required", - "package": "typescript", - "name": "Required" + "package": "typescript" } } ] }, { - "id": 56, + "id": 66, "name": "ensureTrailingSlash", "kind": 64, "kindString": "Function", @@ -3283,19 +5340,20 @@ { "fileName": "src/lib/helpers.ts", "line": 12, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L12" } ], "signatures": [ { - "id": 57, + "id": 67, "name": "ensureTrailingSlash", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 58, + "id": 68, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -3314,7 +5372,7 @@ ] }, { - "id": 65, + "id": 78, "name": "isBrowser", "kind": 64, "kindString": "Function", @@ -3323,12 +5381,13 @@ { "fileName": "src/lib/helpers.ts", "line": 16, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L16" } ], "signatures": [ { - "id": 66, + "id": 79, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", @@ -3341,7 +5400,7 @@ ] }, { - "id": 54, + "id": 64, "name": "uuid", "kind": 64, "kindString": "Function", @@ -3350,19 +5409,94 @@ { "fileName": "src/lib/helpers.ts", "line": 4, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L4" } ], "signatures": [ { - "id": 55, + "id": 65, "name": "uuid", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 75, + "name": "validateSupabaseUrl", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 82, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L82" + } + ], + "signatures": [ + { + "id": 76, + "name": "validateSupabaseUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validates a Supabase client URL" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "- The validated base URL." + } + ] + }, + { + "tag": "@throws", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 77, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Supabase client URL string." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" } } ] @@ -3371,27 +5505,27 @@ "groups": [ { "title": "Functions", - "kind": 64, - "children": [59, 56, 65, 54] + "children": [69, 66, 78, 64, 75] } ], "sources": [ { "fileName": "src/lib/helpers.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L2" } ] }, { - "id": 67, + "id": 80, "name": "lib/types", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", @@ -3399,8 +5533,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 7, - "character": 17 + "line": 8, + "character": 17, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L8" } ], "extendedTypes": [ @@ -3411,7 +5546,7 @@ ] }, { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -3419,23 +5554,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } }, { - "id": 112, + "id": 128, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", @@ -3443,21 +5579,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 + "line": 117, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" } ], "type": { "type": "reflection", "declaration": { - "id": 113, + "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, + "id": 130, "name": "Args", "kind": 1024, "kindString": "Property", @@ -3465,8 +5602,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 118, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L118" } ], "type": { @@ -3481,13 +5619,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 115, + "id": 131, "name": "Returns", "kind": 1024, "kindString": "Property", @@ -3495,8 +5633,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 + "line": 119, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L119" } ], "type": { @@ -3508,22 +5647,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [114, 115] + "children": [130, 131] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, - "character": 30 + "line": 117, + "character": 30, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" } ] } } }, { - "id": 107, + "id": 123, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -3531,21 +5670,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 + "line": 110, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ], "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 110, + "id": 126, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -3553,21 +5693,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 + "line": 112, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L112" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 93, + "id": 109, "name": "GenericRelationship" } } }, { - "id": 109, + "id": 125, "name": "Row", "kind": 1024, "kindString": "Property", @@ -3575,8 +5716,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 + "line": 111, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L111" } ], "type": { @@ -3591,31 +5733,31 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [110, 109] + "children": [126, 125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 38 + "line": 110, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ] } } }, { - "id": 93, + "id": 109, "name": "GenericRelationship", "kind": 4194304, "kindString": "Type alias", @@ -3623,21 +5765,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, - "character": 12 + "line": 93, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" } ], "type": { "type": "reflection", "declaration": { - "id": 94, + "id": 110, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 96, + "id": 112, "name": "columns", "kind": 1024, "kindString": "Property", @@ -3645,8 +5788,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 + "line": 95, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L95" } ], "type": { @@ -3658,7 +5802,7 @@ } }, { - "id": 95, + "id": 111, "name": "foreignKeyName", "kind": 1024, "kindString": "Property", @@ -3666,8 +5810,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 + "line": 94, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L94" } ], "type": { @@ -3676,7 +5821,7 @@ } }, { - "id": 97, + "id": 113, "name": "isOneToOne", "kind": 1024, "kindString": "Property", @@ -3686,8 +5831,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L96" } ], "type": { @@ -3696,7 +5842,7 @@ } }, { - "id": 99, + "id": 115, "name": "referencedColumns", "kind": 1024, "kindString": "Property", @@ -3704,8 +5850,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, - "character": 2 + "line": 98, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L98" } ], "type": { @@ -3717,7 +5864,7 @@ } }, { - "id": 98, + "id": 114, "name": "referencedRelation", "kind": 1024, "kindString": "Property", @@ -3725,8 +5872,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 + "line": 97, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L97" } ], "type": { @@ -3738,22 +5886,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [96, 95, 97, 99, 98] + "children": [112, 111, 113, 115, 114] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, - "character": 34 + "line": 93, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" } ] } } }, { - "id": 116, + "id": 132, "name": "GenericSchema", "kind": 4194304, "kindString": "Type alias", @@ -3761,21 +5909,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 12 + "line": 122, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" } ], "type": { "type": "reflection", "declaration": { - "id": 117, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 120, + "id": 136, "name": "Functions", "kind": 1024, "kindString": "Property", @@ -3783,8 +5932,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 115, - "character": 2 + "line": 125, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L125" } ], "type": { @@ -3796,17 +5946,17 @@ }, { "type": "reference", - "id": 112, + "id": 128, "name": "GenericFunction" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 118, + "id": 134, "name": "Tables", "kind": 1024, "kindString": "Property", @@ -3814,8 +5964,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 + "line": 123, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L123" } ], "type": { @@ -3827,17 +5978,17 @@ }, { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 119, + "id": 135, "name": "Views", "kind": 1024, "kindString": "Property", @@ -3845,8 +5996,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, - "character": 2 + "line": 124, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L124" } ], "type": { @@ -3858,35 +6010,35 @@ }, { "type": "reference", - "id": 111, + "id": 127, "name": "GenericView" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [120, 118, 119] + "children": [136, 134, 135] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 28 + "line": 122, + "character": 28, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" } ] } } }, { - "id": 100, + "id": 116, "name": "GenericTable", "kind": 4194304, "kindString": "Type alias", @@ -3894,21 +6046,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 + "line": 101, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" } ], "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 119, "name": "Insert", "kind": 1024, "kindString": "Property", @@ -3916,8 +6069,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 + "line": 103, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L103" } ], "type": { @@ -3932,13 +6086,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 105, + "id": 121, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -3946,21 +6100,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 95, - "character": 2 + "line": 105, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L105" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 93, + "id": 109, "name": "GenericRelationship" } } }, { - "id": 102, + "id": 118, "name": "Row", "kind": 1024, "kindString": "Property", @@ -3968,8 +6123,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 + "line": 102, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L102" } ], "type": { @@ -3984,13 +6140,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 104, + "id": 120, "name": "Update", "kind": 1024, "kindString": "Property", @@ -3998,8 +6154,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, - "character": 2 + "line": 104, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L104" } ], "type": { @@ -4014,31 +6171,31 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [103, 105, 102, 104] + "children": [119, 121, 118, 120] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, - "character": 27 + "line": 101, + "character": 27, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" } ] } } }, { - "id": 106, + "id": 122, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -4046,18 +6203,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 + "line": 108, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L108" } ], "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } }, { - "id": 111, + "id": 127, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", @@ -4065,8 +6223,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 105, - "character": 12 + "line": 115, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L115" } ], "type": { @@ -4074,19 +6233,19 @@ "types": [ { "type": "reference", - "id": 106, + "id": 122, "name": "GenericUpdatableView" }, { "type": "reference", - "id": 107, + "id": 123, "name": "GenericNonUpdatableView" } ] } }, { - "id": 123, + "id": 139, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", @@ -4094,13 +6253,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 12 + "line": 132, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 126, + "id": 142, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -4111,7 +6271,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 126, + "id": 142, "name": "T" }, "extendsType": { @@ -4120,14 +6280,14 @@ { "type": "reflection", "declaration": { - "id": 124, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 125, + "id": 141, "name": "data", "kind": 1024, "kindString": "Property", @@ -4135,8 +6295,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 51 + "line": 132, + "character": 51, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ], "type": { @@ -4148,23 +6309,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [125] + "children": [141] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 49 + "line": 132, + "character": 49, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ] } } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "trueType": { "type": "reference", @@ -4178,9 +6339,9 @@ "value": null } ], + "name": "Exclude", "qualifiedName": "Exclude", - "package": "typescript", - "name": "Exclude" + "package": "typescript" }, "falseType": { "type": "intrinsic", @@ -4189,7 +6350,7 @@ } }, { - "id": 127, + "id": 143, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", @@ -4197,36 +6358,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 123, - "character": 12 + "line": 133, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L133" } ], "type": { "type": "reference", + "name": "PostgrestError", "qualifiedName": "PostgrestError", - "package": "@supabase/postgrest-js", - "name": "PostgrestError" + "package": "@supabase/postgrest-js" } }, { - "id": 121, + "id": 137, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "Helper types for query results." + "summary": [ + { + "kind": "text", + "text": "Helper types for query results." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 121, - "character": 12 + "line": 131, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L131" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 122, + "id": 138, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -4237,7 +6405,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 122, + "id": 138, "name": "T" }, "extendsType": { @@ -4248,9 +6416,9 @@ "name": "U" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "trueType": { "type": "reference", @@ -4263,7 +6431,7 @@ } }, { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -4271,13 +6439,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4287,14 +6456,95 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, "name": "auth", "kind": 1024, "kindString": "Property", @@ -4304,21 +6554,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 90, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -4326,13 +6577,19 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -4341,7 +6598,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -4349,13 +6606,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -4366,13 +6629,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -4380,13 +6643,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -4395,7 +6664,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -4403,13 +6672,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -4420,13 +6695,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -4434,19 +6709,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -4457,13 +6733,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -4471,13 +6747,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -4486,7 +6768,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -4494,13 +6776,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -4511,13 +6799,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -4525,40 +6813,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -4566,26 +6898,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -4595,13 +6941,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName" } } @@ -4609,22 +6956,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -4634,21 +6981,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4656,23 +7004,37 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch" } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4680,13 +7042,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -4701,31 +7069,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -4733,90 +7101,64 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -4826,32 +7168,31 @@ "groups": [ { "title": "Interfaces", - "kind": 256, - "children": [68] + "children": [81] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] + "children": [82, 128, 123, 109, 132, 116, 122, 127, 139, 143, 137, 83] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L1" } ] }, { - "id": 128, + "id": 144, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 129, + "id": 145, "name": "version", "kind": 32, "kindString": "Variable", @@ -4862,7 +7203,8 @@ { "fileName": "src/lib/version.ts", "line": 1, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" } ], "type": { @@ -4875,15 +7217,15 @@ "groups": [ { "title": "Variables", - "kind": 32, - "children": [129] + "children": [145] } ], "sources": [ { "fileName": "src/lib/version.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" } ] } @@ -4891,8 +7233,7 @@ "groups": [ { "title": "Modules", - "kind": 2, - "children": [1, 10, 24, 53, 67, 128] + "children": [1, 20, 34, 63, 80, 144] } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json index ff55b75f65d9d..9f0639733286a 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json @@ -13,78 +13,86 @@ "flags": {}, "children": [ { - "id": 227, + "id": 270, "name": "QueryData", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 50 + "character": 50, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 123 + "target": 139 }, { - "id": 228, + "id": 271, "name": "QueryError", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 61 + "character": 61, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 127 + "target": 143 }, { - "id": 226, + "id": 269, "name": "QueryResult", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 37 + "character": 37, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 121 + "target": 137 }, { - "id": 225, + "id": 268, "name": "SupabaseClientOptions", - "kind": 16777216, + "kind": 8388608, "kindString": "Reference", "flags": {}, "sources": [ { "fileName": "src/index.ts", "line": 22, - "character": 14 + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L22" } ], - "target": 70 + "target": 83 }, { - "id": 130, + "id": 146, "name": "SupabaseClient", "kind": 128, "kindString": "Class", "flags": {}, "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" + "summary": [ + { + "kind": "text", + "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." + } + ] }, "children": [ { - "id": 131, + "id": 147, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -92,23 +100,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 70, - "character": 2 + "line": 99, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L99" } ], "signatures": [ { - "id": 132, + "id": 148, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "comment": { - "shortText": "Create a new client for use in the browser." + "summary": [ + { + "kind": "text", + "text": "Create a new client for use in the browser." + } + ] }, "typeParameter": [ { - "id": 133, + "id": 149, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -119,14 +133,64 @@ } }, { - "id": 134, - "name": "SchemaName", + "id": 152, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 150, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 151, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [151] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] + } + } + ] }, "default": { "type": "conditional", @@ -135,13 +199,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -155,27 +231,166 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } + } + }, + { + "id": 153, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } } } }, { - "id": 135, + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "default": { @@ -184,18 +399,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 134, + "id": 153, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -211,329 +438,149 @@ }, "falseType": { "type": "intrinsic", - "name": "any" + "name": "never" } } - } - ], - "parameters": [ - { - "id": 136, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } }, { - "id": 137, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", + "id": 165, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", "flags": {}, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 138, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, "type": { - "type": "reference", - "id": 70, - "typeArguments": [ - { - "type": "reference", - "id": 134, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions", - "dereferenced": { - "id": 70, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "sources": [ + "children": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "id": 156, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "typeParameter": [ + "groups": [ { - "id": 92, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} + "title": "Properties", + "children": [156] } ], - "type": { + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 149, + "name": "Database" + }, + "extendsType": { "type": "reflection", "declaration": { - "id": 71, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, - "name": "auth", + "id": 158, + "name": "__InternalSupabase", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 83, - "name": "debug", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 80, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 82, - "name": "flowType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 84, - "name": "lock", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 79, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 81, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 68, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 78, - "name": "storageKey", + "id": 160, + "name": "PostgrestVersion", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - }, + "flags": {}, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ], "type": { @@ -545,90 +592,332 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [160] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" } ] } } - }, + } + ], + "groups": [ { - "id": 72, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 74, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "SchemaName", - "dereferenced": {} - } - } - ], - "groups": [ + "title": "Properties", + "children": [158] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 162, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [162] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 164, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [164] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + ], + "parameters": [ + { + "id": 166, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 167, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 168, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 83, + "typeArguments": [ + { + "type": "reference", + "id": 153, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions", + "dereferenced": { + "id": 83, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ], + "typeParameters": [ + { + "id": 108, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 84, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ { - "title": "Properties", - "kind": 1024, - "children": [74] + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" } ], - "sources": [ + "signatures": [ { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } } ] } } }, { - "id": 86, - "name": "global", + "id": 88, + "name": "auth", "kind": 1024, "kindString": "Property", "flags": { @@ -637,115 +926,336 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, - "name": "fetch", + "id": 90, + "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { - "type": "reference", - "id": 69, - "name": "Fetch", - "dereferenced": { - "id": 69, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 28, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 97, + "name": "debug", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "debug" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" } } }, { - "id": 89, - "name": "headers", + "id": 93, + "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 96, + "name": "flowType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "type": "intrinsic", - "name": "string" - }, + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "flowType" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 98, + "name": "lock", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "type": "intrinsic", - "name": "string" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "lock" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 92, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 94, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 91, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } @@ -753,97 +1263,300 @@ }, { "id": 85, - "name": "realtime", + "name": "db", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 87, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" + } + ], + "type": { + "type": "reference", + "id": 108, + "name": "SchemaName", + "dereferenced": {} + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [87] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" + } + ] + } } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 101, + "name": "global", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", + "type": { + "type": "reflection", + "declaration": { + "id": 102, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ + "children": [ + { + "id": 103, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" + } + ], + "type": { + "type": "reference", + "id": 82, + "name": "Fetch", + "dereferenced": { + "id": 82, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 38, + "name": "fetch", + "qualifiedName": "fetch", + "package": "typescript" + } + } + } + } + }, + { + "id": 104, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" }, { "type": "intrinsic", "name": "string" } - ] + ], + "name": "Record", + "qualifiedName": "Record", + "package": "typescript" } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + } + ], + "groups": [ + { + "title": "Properties", + "children": [103, 104] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" + } + ] + } + } + }, + { + "id": 99, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } - ] + ], + "type": { + "type": "reference", + "name": "RealtimeClientOptions", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js" + } + }, + { + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" + } + ], + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -854,22 +1567,32 @@ ], "type": { "type": "reference", - "id": 130, + "id": 146, "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 134, + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + { + "type": "reference", + "id": 153, "name": "SchemaName" }, { "type": "reference", - "id": 135, + "id": 154, "name": "Schema" + }, + { + "type": "reference", + "id": 165, + "name": "ClientOptions" } ], "name": "default" @@ -878,7 +1601,7 @@ ] }, { - "id": 153, + "id": 184, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -889,21 +1612,30 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 54, - "character": 12 + "line": 82, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" } ], "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 82, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L82" + } + ], "signatures": [ { - "id": 155, + "id": 186, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -925,9 +1657,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -935,19 +1667,25 @@ } }, { - "id": 139, + "id": 169, "name": "auth", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + "summary": [ + { + "kind": "text", + "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 43, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L67" } ], "type": { @@ -956,7 +1694,7 @@ } }, { - "id": 142, + "id": 173, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -966,19 +1704,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 47, - "character": 12 + "line": 75, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L75" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 152, + "id": 183, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -989,8 +1728,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 53, - "character": 12 + "line": 81, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L81" } ], "type": { @@ -999,7 +1739,7 @@ } }, { - "id": 147, + "id": 178, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1010,28 +1750,36 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 52, - "character": 12 + "line": 80, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L80" } ], "type": { "type": "reflection", "declaration": { - "id": 148, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 149, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 150, + "id": 181, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1041,21 +1789,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 151, + "id": 182, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1064,9 +1812,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -1075,14 +1823,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -1090,7 +1838,7 @@ } }, { - "id": 144, + "id": 175, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -1100,19 +1848,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 49, - "character": 12 + "line": 77, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L77" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 156, + "id": 187, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1122,8 +1871,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 12 + "line": 84, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L84" } ], "type": { @@ -1138,13 +1888,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 140, + "id": 170, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -1152,19 +1902,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 44, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L68" } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } }, { - "id": 141, + "id": 172, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -1174,19 +1925,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 46, - "character": 12 + "line": 74, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L74" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 145, + "id": 176, "name": "rest", "kind": 1024, "kindString": "Property", @@ -1196,8 +1948,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 50, - "character": 12 + "line": 78, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L78" } ], "type": { @@ -1205,27 +1958,105 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 134, - "name": "SchemaName" + "id": 165, + "name": "ClientOptions" }, { "type": "reference", - "id": 135, - "name": "Schema" + "id": 153, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" + } + }, + { + "id": 171, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + } + ] + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 72, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L72" + } + ], + "type": { + "type": "reference", + "name": "StorageClient", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js" } }, { - "id": 146, + "id": 177, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -1235,8 +2066,9 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 51, - "character": 12 + "line": 79, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L79" } ], "type": { @@ -1245,7 +2077,7 @@ } }, { - "id": 143, + "id": 174, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -1255,109 +2087,114 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 48, - "character": 12 + "line": 76, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L76" } ], "type": { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } }, { - "id": 158, + "id": 189, "name": "supabaseKey", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + } + ] + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 101, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L101" + } + ], "type": { "type": "intrinsic", "name": "string" } }, { - "id": 157, + "id": 188, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 159, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + } + ] + }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 141, - "character": 6 + "line": 100, + "character": 14, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L100" } ], - "getSignature": [ - { - "id": 160, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 161, - "name": "storage", + "id": 190, + "name": "functions", "kind": 262144, "kindString": "Accessor", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 151, - "character": 6 + "line": 174, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L174" } ], - "getSignature": [ - { - "id": 162, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } + "getSignature": { + "id": 191, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Supabase Functions allows you to deploy and invoke edge functions." + } + ] + }, + "type": { + "type": "reference", + "name": "FunctionsClient", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js" } - ] + } }, { - "id": 200, + "id": 229, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -1367,13 +2204,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 271, - "character": 16 + "line": 300, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L300" } ], "signatures": [ { - "id": 201, + "id": 230, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -1395,15 +2233,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 217, + "id": 246, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -1413,33 +2251,34 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 331, - "character": 10 + "line": 364, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L364" } ], "signatures": [ { - "id": 218, + "id": 247, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 248, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "AuthChangeEvent", "qualifiedName": "AuthChangeEvent", - "package": "@supabase/auth-js", - "name": "AuthChangeEvent" + "package": "@supabase/auth-js" } }, { - "id": 220, + "id": 249, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -1459,7 +2298,7 @@ } }, { - "id": 221, + "id": 250, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -1480,7 +2319,7 @@ ] }, { - "id": 211, + "id": 240, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -1490,43 +2329,44 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 317, - "character": 10 + "line": 350, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L350" } ], "signatures": [ { - "id": 212, + "id": 241, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 242, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 202, + "id": 231, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -1536,30 +2376,31 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 281, - "character": 10 + "line": 310, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L310" } ], "signatures": [ { - "id": 203, + "id": 232, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 204, + "id": 233, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "dereferenced": { - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", @@ -1567,8 +2408,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 7, - "character": 17 + "line": 8, + "character": 17, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L8" } ], "extendedTypes": [ @@ -1581,7 +2423,7 @@ } }, { - "id": 205, + "id": 234, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -1600,13 +2442,13 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 206, + "id": 235, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -1616,21 +2458,28 @@ "type": { "type": "reflection", "declaration": { - "id": 207, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 208, + "id": 237, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 209, + "id": 238, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1640,21 +2489,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 210, + "id": 239, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1663,9 +2512,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -1674,14 +2523,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -1697,7 +2546,7 @@ ] }, { - "id": 214, + "id": 243, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1707,13 +2556,14 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 324, - "character": 10 + "line": 357, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L357" } ], "signatures": [ { - "id": 215, + "id": 244, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1721,18 +2571,25 @@ "type": { "type": "reflection", "declaration": { - "id": 216, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/auth-js/dist/module/GoTrueClient.d.ts", + "line": 313, + "character": 108 + } + ] } } } ] }, { - "id": 189, + "id": 218, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1740,29 +2597,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 243, - "character": 2 + "line": 272, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L272" } ], "signatures": [ { - "id": 190, + "id": 219, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + "summary": [ + { + "kind": "text", + "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + } + ] }, "parameters": [ { - "id": 191, + "id": 220, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel." + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "intrinsic", @@ -1770,34 +2638,39 @@ } }, { - "id": 192, + "id": 221, "name": "opts", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The options to pass to the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "RealtimeChannelOptions", "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" + "package": "@supabase/realtime-js" }, "defaultValue": "..." } ], "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ] }, { - "id": 163, + "id": 192, "name": "from", "kind": 2048, "kindString": "Method", @@ -1805,23 +2678,41 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 156, - "character": 2 + "line": 182, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L182" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 186, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L186" + }, + { + "fileName": "src/SupabaseClient.ts", + "line": 194, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L194" } ], "signatures": [ { - "id": 164, + "id": 193, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 165, + "id": 194, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1832,31 +2723,36 @@ } }, { - "id": 166, + "id": 195, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } } ], "parameters": [ { - "id": 167, + "id": 196, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 165, + "id": 194, "name": "TableName", "dereferenced": {} } @@ -1867,41 +2763,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, { "type": "reference", - "id": 165, + "id": 194, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 166, + "id": 195, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 168, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -1909,23 +2817,28 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } }, { - "id": 169, + "id": 198, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a query on a table or a view." + "summary": [ + { + "kind": "text", + "text": "Perform a query on a table or a view." + } + ] }, "typeParameter": [ { - "id": 170, + "id": 199, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1936,31 +2849,36 @@ } }, { - "id": 171, + "id": 200, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 111, + "id": 127, "name": "GenericView" } } ], "parameters": [ { - "id": 172, + "id": 201, "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table or view name to query\n" + "summary": [ + { + "kind": "text", + "text": "The table or view name to query" + } + ] }, "type": { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName", "dereferenced": {} } @@ -1971,41 +2889,53 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, { "type": "reference", - "id": 170, + "id": 199, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 171, + "id": 200, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 173, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {} + "flags": {}, + "sources": [ + { + "fileName": "node_modules/@supabase/postgrest-js/dist/cjs/PostgrestQueryBuilder.d.ts", + "line": 4, + "character": 218 + } + ] } }, "trueType": { "type": "reference", + "name": "R", "qualifiedName": "R", - "package": "@supabase/postgrest-js", - "name": "R" + "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", @@ -2013,15 +2943,15 @@ } } ], + "name": "default", "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 193, + "id": 222, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -2029,34 +2959,40 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 250, - "character": 2 + "line": 279, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L279" } ], "signatures": [ { - "id": 194, + "id": 223, "name": "getChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns all Realtime channels." + "summary": [ + { + "kind": "text", + "text": "Returns all Realtime channels." + } + ] }, "type": { "type": "array", "elementType": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } } ] }, { - "id": 198, + "id": 227, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -2064,19 +3000,25 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 267, - "character": 2 + "line": 296, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L296" } ], "signatures": [ { - "id": 199, + "id": 228, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes all Realtime channels from Realtime client." + } + ] }, "type": { "type": "reference", @@ -2102,15 +3044,15 @@ } } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 195, + "id": 224, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -2118,35 +3060,46 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 260, - "character": 2 + "line": 289, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L289" } ], "signatures": [ { - "id": 196, + "id": 225, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + "summary": [ + { + "kind": "text", + "text": "Unsubscribes and removes Realtime channel from Realtime client." + } + ] }, "parameters": [ { - "id": 197, + "id": 226, "name": "channel", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The name of the Realtime channel.\n\n" + "summary": [ + { + "kind": "text", + "text": "The name of the Realtime channel." + } + ] }, "type": { "type": "reference", + "name": "default", "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" + "package": "@supabase/realtime-js" } } ], @@ -2171,15 +3124,15 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] }, { - "id": 178, + "id": 207, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2187,23 +3140,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 214, - "character": 2 + "line": 241, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L241" } ], "signatures": [ { - "id": 179, + "id": 208, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a function call." + "summary": [ + { + "kind": "text", + "text": "Perform a function call." + } + ] }, "typeParameter": [ { - "id": 180, + "id": 209, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2214,43 +3173,53 @@ } }, { - "id": 181, + "id": 210, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 112, + "id": 128, "name": "GenericFunction" } } ], "parameters": [ { - "id": 182, + "id": 211, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call" + "summary": [ + { + "kind": "text", + "text": "The function name to call" + } + ] }, "type": { "type": "reference", - "id": 180, + "id": 209, "name": "FnName", "dereferenced": {} } }, { - "id": 183, + "id": 212, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The arguments to pass to the function call" + "summary": [ + { + "kind": "text", + "text": "The arguments to pass to the function call" + } + ] }, "type": { "type": "indexedAccess", @@ -2260,32 +3229,37 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 184, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters" + "summary": [ + { + "kind": "text", + "text": "Named parameters" + } + ] }, "type": { "type": "reflection", "declaration": { - "id": 185, + "id": 214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 188, + "id": 217, "name": "count", "kind": 1024, "kindString": "Property", @@ -2293,13 +3267,51 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + "summary": [ + { + "kind": "text", + "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" + }, + { + "kind": "code", + "text": "`\"exact\"`" + }, + { + "kind": "text", + "text": ": Exact but slow count algorithm. Performs a " + }, + { + "kind": "code", + "text": "`COUNT(*)`" + }, + { + "kind": "text", + "text": " under the\nhood.\n\n" + }, + { + "kind": "code", + "text": "`\"planned\"`" + }, + { + "kind": "text", + "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" + }, + { + "kind": "code", + "text": "`\"estimated\"`" + }, + { + "kind": "text", + "text": ": Uses exact count for low numbers and planned count for high\nnumbers." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 220, - "character": 6 + "line": 247, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L247" } ], "type": { @@ -2321,7 +3333,7 @@ } }, { - "id": 187, + "id": 216, "name": "get", "kind": 1024, "kindString": "Property", @@ -2329,13 +3341,27 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, the function will be called with\nread-only access mode." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", the function will be called with\nread-only access mode." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 219, - "character": 6 + "line": 246, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L246" } ], "type": { @@ -2344,7 +3370,7 @@ } }, { - "id": 186, + "id": 215, "name": "head", "kind": 1024, "kindString": "Property", @@ -2352,13 +3378,35 @@ "isOptional": true }, "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + "summary": [ + { + "kind": "text", + "text": "When set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " will not be returned.\nUseful if you only need the count." + } + ] }, "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, - "character": 6 + "line": 245, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L245" } ], "type": { @@ -2370,8 +3418,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [188, 187, 186] + "children": [217, 216, 215] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 244, + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L244" } ] } @@ -2384,7 +3439,12 @@ "typeArguments": [ { "type": "reference", - "id": 135, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 154, "name": "Schema" }, { @@ -2397,7 +3457,7 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, @@ -2440,9 +3500,9 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" }, "trueType": { "type": "indexedAccess", @@ -2473,29 +3533,33 @@ }, "objectType": { "type": "reference", - "id": 181, + "id": 210, "name": "Fn" } }, { "type": "reference", - "id": 180, + "id": 209, "name": "FnName" }, { "type": "literal", "value": null + }, + { + "type": "literal", + "value": "RPC" } ], + "name": "default", "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] }, { - "id": 174, + "id": 203, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2503,24 +3567,29 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 180, - "character": 2 + "line": 206, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L206" } ], "signatures": [ { - "id": 175, + "id": 204, "name": "schema", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.", - "text": "The schema needs to be on the list of exposed schemas inside Supabase.\n" + "summary": [ + { + "kind": "text", + "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." + } + ] }, "typeParameter": [ { - "id": 176, + "id": 205, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2533,17 +3602,22 @@ ], "parameters": [ { - "id": 177, + "id": 206, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The schema to query\n" + "summary": [ + { + "kind": "text", + "text": "The schema to query" + } + ] }, "type": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema", "dereferenced": {} } @@ -2554,12 +3628,17 @@ "typeArguments": [ { "type": "reference", - "id": 133, + "id": 149, "name": "Database" }, { "type": "reference", - "id": 176, + "id": 165, + "name": "ClientOptions" + }, + { + "type": "reference", + "id": 205, "name": "DynamicSchema" }, { @@ -2568,18 +3647,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 176, + "id": 205, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 133, + "id": 149, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 116, + "id": 132, "name": "GenericSchema" }, "trueType": { @@ -2599,9 +3678,9 @@ } } ], + "name": "default", "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" + "package": "@supabase/postgrest-js" } } ] @@ -2610,35 +3689,34 @@ "groups": [ { "title": "Constructors", - "kind": 512, - "children": [131] + "children": [147] }, { "title": "Properties", - "kind": 1024, - "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] + "children": [ + 184, 169, 173, 183, 178, 175, 187, 170, 172, 176, 171, 177, 174, 189, 188 + ] }, { "title": "Accessors", - "kind": 262144, - "children": [159, 161] + "children": [190] }, { "title": "Methods", - "kind": 2048, - "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] + "children": [229, 246, 240, 231, 243, 218, 192, 222, 227, 224, 207, 203] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 31, - "character": 21 + "character": 21, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L31" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 222, + "id": 251, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2649,49 +3727,498 @@ } }, { - "id": 223, - "name": "SchemaName", + "id": 254, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intersection", + "type": "union", "types": [ { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 133, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", + "type": "reflection", + "declaration": { + "id": 252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 253, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [253] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 38, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L38" + } + ] + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } }, "trueType": { "type": "literal", "value": "public" }, - "falseType": { + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 255, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + }, + "trueType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + } + ] + } + } + } + }, + { + "id": 256, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + }, + { + "id": 267, + "name": "ClientOptions", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 257, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 258, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 26, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [258] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 53, + "character": 24, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L53" + } + ] + } + }, + "default": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { "type": "intersection", "types": [ { @@ -2703,61 +4230,236 @@ "operator": "keyof", "target": { "type": "reference", - "id": 133, - "name": "Database" + "typeArguments": [ + { + "type": "reference", + "id": 149, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" } } ] - } - } - }, - { - "id": 224, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 116, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 134, - "name": "SchemaName" - }, - "objectType": { + }, + "trueType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 133, + "id": 149, "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 259, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 260, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 261, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 262, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [262] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [260] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "id": 149, + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 263, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 264, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [264] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } } }, - "extendsType": { - "type": "reference", - "id": 116, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 134, - "name": "SchemaName" + "id": 152, + "name": "SchemaNameOrClientOptions" }, - "objectType": { + "extendsType": { + "type": "reflection", + "declaration": { + "id": 265, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 266, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [266] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" + } + ] + } + }, + "trueType": { "type": "reference", - "id": 133, - "name": "Database" + "id": 152, + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - }, - "falseType": { - "type": "intrinsic", - "name": "any" } } } @@ -2773,7 +4475,8 @@ { "fileName": "src/index.ts", "line": 27, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L27" } ], "signatures": [ @@ -2784,7 +4487,12 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new Supabase Client." + "summary": [ + { + "kind": "text", + "text": "Creates a new Supabase Client." + } + ] }, "typeParameter": [ { @@ -2799,14 +4507,64 @@ } }, { - "id": 5, - "name": "SchemaName", + "id": 7, + "name": "SchemaNameOrClientOptions", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 6, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [6] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 31, + "character": 6, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L31" + } + ] + } + } + ] }, "default": { "type": "conditional", @@ -2815,13 +4573,25 @@ "value": "public" }, "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" }, "trueType": { "type": "literal", @@ -2835,70 +4605,161 @@ "name": "string" }, { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" } ] } } }, { - "id": 6, - "name": "Schema", + "id": 8, + "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "id": 116, - "name": "GenericSchema" + "type": "intrinsic", + "name": "string" }, "default": { "type": "conditional", "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" }, "extendsType": { - "type": "reference", - "id": 116, - "name": "GenericSchema" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] }, "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } + "type": "reference", + "name": "SchemaNameOrClientOptions" }, "falseType": { - "type": "intrinsic", - "name": "any" + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + } } } } ], "parameters": [ { - "id": 7, + "id": 9, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", @@ -2909,7 +4770,7 @@ } }, { - "id": 8, + "id": 10, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -2920,7 +4781,7 @@ } }, { - "id": 9, + "id": 11, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2929,17 +4790,17 @@ }, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 5, + "id": 8, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -2947,13 +4808,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -2963,14 +4825,95 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, "name": "auth", "kind": 1024, "kindString": "Property", @@ -2980,21 +4923,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 90, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -3002,13 +4946,19 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -3017,7 +4967,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -3025,13 +4975,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -3042,13 +4998,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -3056,13 +5012,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -3071,7 +5033,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -3079,13 +5041,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -3096,13 +5064,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -3110,19 +5078,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -3133,13 +5102,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -3147,13 +5116,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -3162,7 +5137,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -3170,13 +5145,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -3187,13 +5168,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -3201,40 +5182,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -3242,26 +5267,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3271,13 +5310,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -3286,22 +5326,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -3311,21 +5351,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -3333,21 +5374,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -3355,25 +5410,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3381,13 +5437,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -3402,31 +5464,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -3434,117 +5496,388 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" + } + ], + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [105, 88, 85, 101, 99, 100] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "id": 146, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 8, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Omit", + "qualifiedName": "Omit", + "package": "typescript" + } + }, + "extendsType": { + "type": "reference", + "id": 132, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + { + "type": "literal", + "value": "__InternalSupabase" + } + ], + "name": "Exclude", + "qualifiedName": "Exclude", + "package": "typescript" + } + ] + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 4, + "name": "Database" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "__InternalSupabase", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 25, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 14, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 15, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 47, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [15] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 45, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [13] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 23, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L56" + } + ] + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "__InternalSupabase" + }, + "objectType": { + "type": "reference", + "name": "Database" + } + }, + "falseType": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 17, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 10, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ], + "type": { + "type": "literal", + "value": "12" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [17] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 8, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L59" + } + ] + } + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 7, + "name": "SchemaNameOrClientOptions" + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 19, + "name": "PostgrestVersion", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 42, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [19] } ], "sources": [ { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 40, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/SupabaseClient.ts#L60" } ] } + }, + "trueType": { + "type": "reference", + "name": "SchemaNameOrClientOptions" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } } } - } - ], - "type": { - "type": "reference", - "id": 130, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } ], "name": "default" } @@ -3555,17 +5888,14 @@ "groups": [ { "title": "References", - "kind": 16777216, - "children": [227, 228, 226, 225] + "children": [270, 271, 269, 268] }, { "title": "Classes", - "kind": 128, - "children": [130] + "children": [146] }, { "title": "Functions", - "kind": 64, "children": [2] } ], @@ -3573,19 +5903,20 @@ { "fileName": "src/index.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/index.ts#L1" } ] }, { - "id": 10, + "id": 20, "name": "lib/constants", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 22, + "id": 32, "name": "DEFAULT_AUTH_OPTIONS", "kind": 32, "kindString": "Variable", @@ -3596,18 +5927,19 @@ { "fileName": "src/lib/constants.ts", "line": 28, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L28" } ], "type": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" }, "defaultValue": "..." }, { - "id": 19, + "id": 29, "name": "DEFAULT_DB_OPTIONS", "kind": 32, "kindString": "Variable", @@ -3618,20 +5950,21 @@ { "fileName": "src/lib/constants.ts", "line": 24, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ], "type": { "type": "reflection", "declaration": { - "id": 20, + "id": 30, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 21, + "id": 31, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3640,7 +5973,8 @@ { "fileName": "src/lib/constants.ts", "line": 25, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L25" } ], "type": { @@ -3653,8 +5987,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [21] + "children": [31] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 24, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L24" } ] } @@ -3662,7 +6003,7 @@ "defaultValue": "..." }, { - "id": 14, + "id": 24, "name": "DEFAULT_GLOBAL_OPTIONS", "kind": 32, "kindString": "Variable", @@ -3673,20 +6014,21 @@ { "fileName": "src/lib/constants.ts", "line": 20, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 15, + "id": 25, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 16, + "id": 26, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3695,20 +6037,21 @@ { "fileName": "src/lib/constants.ts", "line": 21, - "character": 2 + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L21" } ], "type": { "type": "reflection", "declaration": { - "id": 17, + "id": 27, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 18, + "id": 28, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", @@ -3717,7 +6060,8 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { @@ -3730,8 +6074,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [18] + "children": [28] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ] } @@ -3742,8 +6093,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [16] + "children": [26] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 20, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L20" } ] } @@ -3751,7 +6109,7 @@ "defaultValue": "..." }, { - "id": 11, + "id": 21, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", @@ -3762,20 +6120,21 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { "type": "reflection", "declaration": { - "id": 12, + "id": 22, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 13, + "id": 23, "name": "X-Client-Info", "kind": 1024, "kindString": "Property", @@ -3784,7 +6143,8 @@ { "fileName": "src/lib/constants.ts", "line": 18, - "character": 33 + "character": 33, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ], "type": { @@ -3797,8 +6157,15 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [13] + "children": [23] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 18, + "character": 31, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L18" } ] } @@ -3806,7 +6173,7 @@ "defaultValue": "..." }, { - "id": 23, + "id": 33, "name": "DEFAULT_REALTIME_OPTIONS", "kind": 32, "kindString": "Variable", @@ -3817,14 +6184,15 @@ { "fileName": "src/lib/constants.ts", "line": 35, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L35" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" }, "defaultValue": "{}" } @@ -3832,27 +6200,27 @@ "groups": [ { "title": "Variables", - "kind": 32, - "children": [22, 19, 14, 11, 23] + "children": [32, 29, 24, 21, 33] } ], "sources": [ { "fileName": "src/lib/constants.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/constants.ts#L2" } ] }, { - "id": 24, + "id": 34, "name": "lib/fetch", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 38, + "id": 48, "name": "fetchWithAuth", "kind": 64, "kindString": "Function", @@ -3861,19 +6229,20 @@ { "fileName": "src/lib/fetch.ts", "line": 26, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L26" } ], "signatures": [ { - "id": 39, + "id": 49, "name": "fetchWithAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 40, + "id": 50, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -3884,7 +6253,7 @@ } }, { - "id": 41, + "id": 51, "name": "getAccessToken", "kind": 32768, "kindString": "Parameter", @@ -3892,14 +6261,22 @@ "type": { "type": "reflection", "declaration": { - "id": 42, + "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 28, + "character": 18, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L28" + } + ], "signatures": [ { - "id": 43, + "id": 53, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -3921,9 +6298,9 @@ ] } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -3931,7 +6308,7 @@ } }, { - "id": 44, + "id": 54, "name": "customFetch", "kind": 32768, "kindString": "Parameter", @@ -3941,21 +6318,28 @@ "type": { "type": "reflection", "declaration": { - "id": 45, + "id": 55, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 46, + "id": 56, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 47, + "id": 57, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3965,21 +6349,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 48, + "id": 58, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3988,9 +6372,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -3999,14 +6383,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4017,21 +6401,28 @@ "type": { "type": "reflection", "declaration": { - "id": 49, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 50, + "id": 60, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 51, + "id": 61, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4041,21 +6432,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 52, + "id": 62, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4064,9 +6455,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4075,14 +6466,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4092,7 +6483,7 @@ ] }, { - "id": 25, + "id": 35, "name": "resolveFetch", "kind": 64, "kindString": "Function", @@ -4101,19 +6492,20 @@ { "fileName": "src/lib/fetch.ts", "line": 6, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L6" } ], "signatures": [ { - "id": 26, + "id": 36, "name": "resolveFetch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 27, + "id": 37, "name": "customFetch", "kind": 32768, "kindString": "Parameter", @@ -4123,21 +6515,28 @@ "type": { "type": "reflection", "declaration": { - "id": 28, + "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 29, + "id": 39, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 30, + "id": 40, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4147,21 +6546,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 31, + "id": 41, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4170,9 +6569,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4181,14 +6580,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4199,21 +6598,28 @@ "type": { "type": "reflection", "declaration": { - "id": 32, + "id": 42, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, + "sources": [ + { + "fileName": "node_modules/typescript/lib/lib.dom.d.ts", + "line": 18095, + "character": 17 + } + ], "signatures": [ { - "id": 33, + "id": 43, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 34, + "id": 44, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4223,21 +6629,21 @@ "types": [ { "type": "reference", + "name": "RequestInfo", "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "package": "typescript" }, { "type": "reference", + "name": "URL", "qualifiedName": "URL", - "package": "typescript", - "name": "URL" + "package": "typescript" } ] } }, { - "id": 35, + "id": 45, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4246,9 +6652,9 @@ }, "type": { "type": "reference", + "name": "RequestInit", "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" + "package": "typescript" } } ], @@ -4257,14 +6663,14 @@ "typeArguments": [ { "type": "reference", + "name": "Response", "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "package": "typescript" } ], + "name": "Promise", "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" + "package": "typescript" } } ] @@ -4274,7 +6680,7 @@ ] }, { - "id": 36, + "id": 46, "name": "resolveHeadersConstructor", "kind": 64, "kindString": "Function", @@ -4283,12 +6689,13 @@ { "fileName": "src/lib/fetch.ts", "line": 18, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L18" } ], "signatures": [ { - "id": 37, + "id": 47, "name": "resolveHeadersConstructor", "kind": 4096, "kindString": "Call signature", @@ -4304,27 +6711,27 @@ "groups": [ { "title": "Functions", - "kind": 64, - "children": [38, 25, 36] + "children": [48, 35, 46] } ], "sources": [ { "fileName": "src/lib/fetch.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/fetch.ts#L2" } ] }, { - "id": 53, + "id": 63, "name": "lib/helpers", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 59, + "id": 69, "name": "applySettingDefaults", "kind": 64, "kindString": "Function", @@ -4333,19 +6740,20 @@ { "fileName": "src/lib/helpers.ts", "line": 18, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L18" } ], "signatures": [ { - "id": 60, + "id": 70, "name": "applySettingDefaults", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 61, + "id": 71, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -4356,7 +6764,7 @@ } }, { - "id": 62, + "id": 72, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4376,7 +6784,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 61, + "id": 71, "name": "Database" } }, @@ -4396,7 +6804,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 61, + "id": 71, "name": "Database" } } @@ -4407,24 +6815,24 @@ ], "parameters": [ { - "id": 63, + "id": 73, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 62, + "id": 72, "name": "SchemaName" } ], "name": "SupabaseClientOptions", "dereferenced": { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -4432,13 +6840,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4448,14 +6857,95 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, "name": "auth", "kind": 1024, "kindString": "Property", @@ -4465,21 +6955,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 90, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -4487,13 +6978,19 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -4502,7 +6999,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -4510,13 +7007,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -4527,13 +7030,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -4541,13 +7044,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -4556,7 +7065,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -4564,13 +7073,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -4581,13 +7096,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -4595,19 +7110,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -4618,13 +7134,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -4632,13 +7148,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -4647,7 +7169,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -4655,13 +7177,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -4672,13 +7200,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -4686,40 +7214,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -4727,26 +7299,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -4756,13 +7342,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -4771,22 +7358,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -4796,21 +7383,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4818,21 +7406,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -4840,25 +7442,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4866,13 +7469,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -4887,31 +7496,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -4919,90 +7528,64 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -5011,14 +7594,14 @@ } }, { - "id": 64, + "id": 74, "name": "defaults", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "intrinsic", @@ -5027,7 +7610,7 @@ ], "name": "SupabaseClientOptions", "dereferenced": { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -5035,13 +7618,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -5051,14 +7635,95 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, "name": "auth", "kind": 1024, "kindString": "Property", @@ -5068,21 +7733,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 90, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -5090,13 +7756,19 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -5105,7 +7777,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -5113,13 +7785,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -5130,13 +7808,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -5144,13 +7822,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -5159,7 +7843,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -5167,13 +7851,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -5184,13 +7874,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -5198,19 +7888,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -5221,13 +7912,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -5235,13 +7926,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -5250,7 +7947,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -5258,13 +7955,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -5275,13 +7978,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -5289,40 +7992,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -5330,26 +8077,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -5359,13 +8120,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -5374,22 +8136,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -5399,21 +8161,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -5421,21 +8184,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -5443,25 +8220,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -5469,13 +8247,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -5490,31 +8274,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -5522,90 +8306,64 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -5619,26 +8377,26 @@ "typeArguments": [ { "type": "reference", - "id": 70, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 62, + "id": 72, "name": "SchemaName" } ], "name": "SupabaseClientOptions" } ], + "name": "Required", "qualifiedName": "Required", - "package": "typescript", - "name": "Required" + "package": "typescript" } } ] }, { - "id": 56, + "id": 66, "name": "ensureTrailingSlash", "kind": 64, "kindString": "Function", @@ -5647,19 +8405,20 @@ { "fileName": "src/lib/helpers.ts", "line": 12, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L12" } ], "signatures": [ { - "id": 57, + "id": 67, "name": "ensureTrailingSlash", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 58, + "id": 68, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -5678,7 +8437,7 @@ ] }, { - "id": 65, + "id": 78, "name": "isBrowser", "kind": 64, "kindString": "Function", @@ -5687,12 +8446,13 @@ { "fileName": "src/lib/helpers.ts", "line": 16, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L16" } ], "signatures": [ { - "id": 66, + "id": 79, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", @@ -5705,7 +8465,7 @@ ] }, { - "id": 54, + "id": 64, "name": "uuid", "kind": 64, "kindString": "Function", @@ -5714,19 +8474,94 @@ { "fileName": "src/lib/helpers.ts", "line": 4, - "character": 16 + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L4" } ], "signatures": [ { - "id": 55, + "id": 65, "name": "uuid", "kind": 4096, "kindString": "Call signature", "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 75, + "name": "validateSupabaseUrl", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 82, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L82" + } + ], + "signatures": [ + { + "id": 76, + "name": "validateSupabaseUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validates a Supabase client URL" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "- The validated base URL." + } + ] + }, + { + "tag": "@throws", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 77, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Supabase client URL string." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "name": "URL", + "qualifiedName": "URL", + "package": "typescript" } } ] @@ -5735,27 +8570,27 @@ "groups": [ { "title": "Functions", - "kind": 64, - "children": [59, 56, 65, 54] + "children": [69, 66, 78, 64, 75] } ], "sources": [ { "fileName": "src/lib/helpers.ts", "line": 2, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/helpers.ts#L2" } ] }, { - "id": 67, + "id": 80, "name": "lib/types", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions", "kind": 256, "kindString": "Interface", @@ -5763,8 +8598,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 7, - "character": 17 + "line": 8, + "character": 17, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L8" } ], "extendedTypes": [ @@ -5775,7 +8611,7 @@ ] }, { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -5783,23 +8619,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } }, { - "id": 112, + "id": 128, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", @@ -5807,21 +8644,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 + "line": 117, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" } ], "type": { "type": "reflection", "declaration": { - "id": 113, + "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, + "id": 130, "name": "Args", "kind": 1024, "kindString": "Property", @@ -5829,8 +8667,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 + "line": 118, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L118" } ], "type": { @@ -5845,13 +8684,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 115, + "id": 131, "name": "Returns", "kind": 1024, "kindString": "Property", @@ -5859,8 +8698,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 + "line": 119, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L119" } ], "type": { @@ -5872,22 +8712,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [114, 115] + "children": [130, 131] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, - "character": 30 + "line": 117, + "character": 30, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L117" } ] } } }, { - "id": 107, + "id": 123, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -5895,21 +8735,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 + "line": 110, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ], "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 110, + "id": 126, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -5917,21 +8758,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 + "line": 112, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L112" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 93, + "id": 109, "name": "GenericRelationship" } } }, { - "id": 109, + "id": 125, "name": "Row", "kind": 1024, "kindString": "Property", @@ -5939,8 +8781,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 + "line": 111, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L111" } ], "type": { @@ -5955,31 +8798,31 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [110, 109] + "children": [126, 125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 38 + "line": 110, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ] } } }, { - "id": 93, + "id": 109, "name": "GenericRelationship", "kind": 4194304, "kindString": "Type alias", @@ -5987,21 +8830,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, - "character": 12 + "line": 93, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" } ], "type": { "type": "reflection", "declaration": { - "id": 94, + "id": 110, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 96, + "id": 112, "name": "columns", "kind": 1024, "kindString": "Property", @@ -6009,8 +8853,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 + "line": 95, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L95" } ], "type": { @@ -6022,7 +8867,7 @@ } }, { - "id": 95, + "id": 111, "name": "foreignKeyName", "kind": 1024, "kindString": "Property", @@ -6030,8 +8875,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 + "line": 94, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L94" } ], "type": { @@ -6040,7 +8886,7 @@ } }, { - "id": 97, + "id": 113, "name": "isOneToOne", "kind": 1024, "kindString": "Property", @@ -6050,8 +8896,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, - "character": 2 + "line": 96, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L96" } ], "type": { @@ -6060,7 +8907,7 @@ } }, { - "id": 99, + "id": 115, "name": "referencedColumns", "kind": 1024, "kindString": "Property", @@ -6068,8 +8915,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, - "character": 2 + "line": 98, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L98" } ], "type": { @@ -6081,7 +8929,7 @@ } }, { - "id": 98, + "id": 114, "name": "referencedRelation", "kind": 1024, "kindString": "Property", @@ -6089,8 +8937,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 + "line": 97, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L97" } ], "type": { @@ -6102,22 +8951,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [96, 95, 97, 99, 98] + "children": [112, 111, 113, 115, 114] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, - "character": 34 + "line": 93, + "character": 34, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L93" } ] } } }, { - "id": 116, + "id": 132, "name": "GenericSchema", "kind": 4194304, "kindString": "Type alias", @@ -6125,21 +8974,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 12 + "line": 122, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" } ], "type": { "type": "reflection", "declaration": { - "id": 117, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 120, + "id": 136, "name": "Functions", "kind": 1024, "kindString": "Property", @@ -6147,8 +8997,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 115, - "character": 2 + "line": 125, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L125" } ], "type": { @@ -6160,17 +9011,17 @@ }, { "type": "reference", - "id": 112, + "id": 128, "name": "GenericFunction" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 118, + "id": 134, "name": "Tables", "kind": 1024, "kindString": "Property", @@ -6178,8 +9029,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 + "line": 123, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L123" } ], "type": { @@ -6191,17 +9043,17 @@ }, { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 119, + "id": 135, "name": "Views", "kind": 1024, "kindString": "Property", @@ -6209,8 +9061,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 114, - "character": 2 + "line": 124, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L124" } ], "type": { @@ -6222,35 +9075,35 @@ }, { "type": "reference", - "id": 111, + "id": 127, "name": "GenericView" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [120, 118, 119] + "children": [136, 134, 135] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, - "character": 28 + "line": 122, + "character": 28, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L122" } ] } } }, { - "id": 100, + "id": 116, "name": "GenericTable", "kind": 4194304, "kindString": "Type alias", @@ -6258,21 +9111,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 + "line": 101, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" } ], "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 117, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 119, "name": "Insert", "kind": 1024, "kindString": "Property", @@ -6280,8 +9134,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 + "line": 103, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L103" } ], "type": { @@ -6296,13 +9151,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 105, + "id": 121, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -6310,21 +9165,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 95, - "character": 2 + "line": 105, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L105" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 93, + "id": 109, "name": "GenericRelationship" } } }, { - "id": 102, + "id": 118, "name": "Row", "kind": 1024, "kindString": "Property", @@ -6332,8 +9188,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 + "line": 102, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L102" } ], "type": { @@ -6348,13 +9205,13 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } }, { - "id": 104, + "id": 120, "name": "Update", "kind": 1024, "kindString": "Property", @@ -6362,8 +9219,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, - "character": 2 + "line": 104, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L104" } ], "type": { @@ -6378,31 +9236,31 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [103, 105, 102, 104] + "children": [119, 121, 118, 120] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, - "character": 27 + "line": 101, + "character": 27, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L101" } ] } } }, { - "id": 106, + "id": 122, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6410,18 +9268,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 + "line": 108, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L108" } ], "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } }, { - "id": 111, + "id": 127, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", @@ -6429,15 +9288,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 105, - "character": 12 + "line": 115, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L115" } ], "type": { "type": "union", "types": [ { - "id": 106, + "id": 122, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6445,18 +9305,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 + "line": 108, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L108" } ], "type": { "type": "reference", - "id": 100, + "id": 116, "name": "GenericTable" } }, { - "id": 107, + "id": 123, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6464,21 +9325,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 + "line": 110, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ], "type": { "type": "reflection", "declaration": { - "id": 108, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 110, + "id": 126, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -6486,21 +9348,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 + "line": 112, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L112" } ], "type": { "type": "array", "elementType": { "type": "reference", - "id": 93, + "id": 109, "name": "GenericRelationship" } } }, { - "id": 109, + "id": 125, "name": "Row", "kind": 1024, "kindString": "Property", @@ -6508,8 +9371,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 + "line": 111, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L111" } ], "type": { @@ -6524,24 +9388,24 @@ "name": "unknown" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [110, 109] + "children": [126, 125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, - "character": 38 + "line": 110, + "character": 38, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L110" } ] } @@ -6551,7 +9415,7 @@ } }, { - "id": 123, + "id": 139, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", @@ -6559,13 +9423,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 12 + "line": 132, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 126, + "id": 142, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6576,7 +9441,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 126, + "id": 142, "name": "T" }, "extendsType": { @@ -6585,14 +9450,14 @@ { "type": "reflection", "declaration": { - "id": 124, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 125, + "id": 141, "name": "data", "kind": 1024, "kindString": "Property", @@ -6600,8 +9465,9 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 51 + "line": 132, + "character": 51, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ], "type": { @@ -6613,23 +9479,23 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [125] + "children": [141] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 122, - "character": 49 + "line": 132, + "character": 49, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L132" } ] } } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "trueType": { "type": "reference", @@ -6643,9 +9509,9 @@ "value": null } ], + "name": "Exclude", "qualifiedName": "Exclude", - "package": "typescript", - "name": "Exclude" + "package": "typescript" }, "falseType": { "type": "intrinsic", @@ -6654,7 +9520,7 @@ } }, { - "id": 127, + "id": 143, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", @@ -6662,36 +9528,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 123, - "character": 12 + "line": 133, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L133" } ], "type": { "type": "reference", + "name": "PostgrestError", "qualifiedName": "PostgrestError", - "package": "@supabase/postgrest-js", - "name": "PostgrestError" + "package": "@supabase/postgrest-js" } }, { - "id": 121, + "id": 137, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "Helper types for query results." + "summary": [ + { + "kind": "text", + "text": "Helper types for query results." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 121, - "character": 12 + "line": 131, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L131" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 122, + "id": 138, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6702,7 +9575,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 122, + "id": 138, "name": "T" }, "extendsType": { @@ -6713,9 +9586,9 @@ "name": "U" } ], + "name": "PromiseLike", "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + "package": "typescript" }, "trueType": { "type": "reference", @@ -6728,7 +9601,7 @@ } }, { - "id": 70, + "id": 83, "name": "SupabaseClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -6736,13 +9609,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 12 + "line": 12, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ], - "typeParameter": [ + "typeParameters": [ { - "id": 92, + "id": 108, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -6752,14 +9626,95 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 84, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 75, + "id": 105, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 16, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L90" + } + ], + "signatures": [ + { + "id": 107, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.\n\nWhen set, the " + }, + { + "kind": "code", + "text": "`auth`" + }, + { + "kind": "text", + "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "Promise", + "qualifiedName": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 88, "name": "auth", "kind": 1024, "kindString": "Property", @@ -6769,21 +9724,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 + "line": 20, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ], "type": { "type": "reflection", "declaration": { - "id": 76, + "id": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 90, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -6791,13 +9747,19 @@ "isOptional": true }, "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Automatically refreshes the token for logged-in users. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 23, - "character": 4 + "line": 24, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L24" } ], "type": { @@ -6806,7 +9768,7 @@ } }, { - "id": 83, + "id": 97, "name": "debug", "kind": 1024, "kindString": "Property", @@ -6814,13 +9776,19 @@ "isOptional": true }, "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + "summary": [ + { + "kind": "text", + "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 + "line": 56, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L56" } ], "type": { @@ -6831,13 +9799,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 80, + "id": 93, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -6845,13 +9813,19 @@ "isOptional": true }, "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, - "character": 4 + "line": 36, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L36" } ], "type": { @@ -6860,7 +9834,7 @@ } }, { - "id": 82, + "id": 96, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -6868,13 +9842,19 @@ "isOptional": true }, "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + "summary": [ + { + "kind": "text", + "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, - "character": 4 + "line": 52, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L52" } ], "type": { @@ -6885,13 +9865,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 84, + "id": 98, "name": "lock", "kind": 1024, "kindString": "Property", @@ -6899,19 +9879,20 @@ "isOptional": true }, "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.", - "tags": [ + "summary": [ { - "tag": "experimental", - "text": "\n" + "kind": "text", + "text": "Provide your own locking mechanism based on the environment. By default no locking is done at this time." } - ] + ], + "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, - "character": 4 + "line": 62, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L62" } ], "type": { @@ -6922,13 +9903,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 79, + "id": 92, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -6936,13 +9917,19 @@ "isOptional": true }, "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." + "summary": [ + { + "kind": "text", + "text": "Whether to persist a logged-in session to storage. Defaults to true." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 + "line": 32, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L32" } ], "type": { @@ -6951,7 +9938,7 @@ } }, { - "id": 81, + "id": 94, "name": "storage", "kind": 1024, "kindString": "Property", @@ -6959,13 +9946,19 @@ "isOptional": true }, "comment": { - "shortText": "A storage provider. Used to store the logged-in session." + "summary": [ + { + "kind": "text", + "text": "A storage provider. Used to store the logged-in session." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, - "character": 4 + "line": 40, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L40" } ], "type": { @@ -6976,13 +9969,13 @@ }, "objectType": { "type": "reference", - "id": 68, + "id": 81, "name": "SupabaseAuthClientOptions" } } }, { - "id": 78, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -6990,40 +9983,84 @@ "isOptional": true }, "comment": { - "shortText": "Optional key name used for storing tokens in local storage." + "summary": [ + { + "kind": "text", + "text": "Optional key name used for storing tokens in local storage." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 27, - "character": 4 + "line": 28, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L28" } ], "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 95, + "name": "userStorage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." + } + ], + "modifierTags": ["@experimental"] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L48" + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "userStorage" + }, + "objectType": { + "type": "reference", + "id": 81, + "name": "SupabaseAuthClientOptions" + } + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [77, 83, 80, 82, 84, 79, 81, 78] + "children": [90, 97, 93, 96, 98, 92, 94, 91, 95] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 19, - "character": 9 + "line": 20, + "character": 9, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L20" } ] } } }, { - "id": 72, + "id": 85, "name": "db", "kind": 1024, "kindString": "Property", @@ -7031,26 +10068,40 @@ "isOptional": true }, "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`." + "summary": [ + { + "kind": "text", + "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": "." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 + "line": 16, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ], "type": { "type": "reflection", "declaration": { - "id": 73, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 74, + "id": 87, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7060,13 +10111,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 16, - "character": 4 + "line": 17, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L17" } ], "type": { "type": "reference", - "id": 92, + "id": 108, "name": "SchemaName", "dereferenced": {} } @@ -7075,22 +10127,22 @@ "groups": [ { "title": "Properties", - "kind": 1024, - "children": [74] + "children": [87] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 15, - "character": 7 + "line": 16, + "character": 7, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L16" } ] } } }, { - "id": 86, + "id": 101, "name": "global", "kind": 1024, "kindString": "Property", @@ -7100,21 +10152,22 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 + "line": 69, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ], "type": { "type": "reflection", "declaration": { - "id": 87, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 88, + "id": 103, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -7122,21 +10175,35 @@ "isOptional": true }, "comment": { - "shortText": "A custom `fetch` implementation." + "summary": [ + { + "kind": "text", + "text": "A custom " + }, + { + "kind": "code", + "text": "`fetch`" + }, + { + "kind": "text", + "text": " implementation." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 + "line": 73, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L73" } ], "type": { "type": "reference", - "id": 69, + "id": 82, "name": "Fetch", "dereferenced": { - "id": 69, + "id": 82, "name": "Fetch", "kind": 4194304, "kindString": "Type alias", @@ -7144,25 +10211,26 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 9, - "character": 12 + "line": 10, + "character": 12, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L10" } ], "type": { "type": "query", "queryType": { "type": "reference", - "id": 28, + "id": 38, + "name": "fetch", "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" + "package": "typescript" } } } } }, { - "id": 89, + "id": 104, "name": "headers", "kind": 1024, "kindString": "Property", @@ -7170,13 +10238,19 @@ "isOptional": true }, "comment": { - "shortText": "Optional headers for initializing the client." + "summary": [ + { + "kind": "text", + "text": "Optional headers for initializing the client." + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, - "character": 4 + "line": 77, + "character": 4, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L77" } ], "type": { @@ -7191,31 +10265,31 @@ "name": "string" } ], + "name": "Record", "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "package": "typescript" } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [88, 89] + "children": [103, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, - "character": 11 + "line": 69, + "character": 11, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L69" } ] } } }, { - "id": 85, + "id": 99, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -7223,90 +10297,64 @@ "isOptional": true }, "comment": { - "shortText": "Options passed to the realtime-js instance" + "summary": [ + { + "kind": "text", + "text": "Options passed to the realtime-js instance" + } + ] }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 + "line": 67, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L67" } ], "type": { "type": "reference", + "name": "RealtimeClientOptions", "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" + "package": "@supabase/realtime-js" } }, { - "id": 90, - "name": "accessToken", - "kind": 2048, - "kindString": "Method", + "id": 100, + "name": "storage", + "kind": 1024, + "kindString": "Property", "flags": { "isOptional": true }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 + "line": 68, + "character": 2, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L68" } ], - "signatures": [ - { - "id": 91, - "name": "accessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", - "text": "When set, the `auth` namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "type": { + "type": "reference", + "name": "StorageClientOptions", + "qualifiedName": "StorageClientOptions", + "package": "@supabase/storage-js" + } } ], "groups": [ { "title": "Properties", - "kind": 1024, - "children": [75, 72, 86, 85] - }, - { - "title": "Methods", - "kind": 2048, - "children": [90] + "children": [105, 88, 85, 101, 99, 100] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 11, - "character": 48 + "line": 12, + "character": 48, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L12" } ] } @@ -7316,32 +10364,31 @@ "groups": [ { "title": "Interfaces", - "kind": 256, - "children": [68] + "children": [81] }, { "title": "Type Aliases", - "kind": 4194304, - "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] + "children": [82, 128, 123, 109, 132, 116, 122, 127, 139, 143, 137, 83] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/types.ts#L1" } ] }, { - "id": 128, + "id": 144, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 129, + "id": 145, "name": "version", "kind": 32, "kindString": "Variable", @@ -7352,7 +10399,8 @@ { "fileName": "src/lib/version.ts", "line": 1, - "character": 13 + "character": 13, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" } ], "type": { @@ -7365,15 +10413,15 @@ "groups": [ { "title": "Variables", - "kind": 32, - "children": [129] + "children": [145] } ], "sources": [ { "fileName": "src/lib/version.ts", "line": 1, - "character": 0 + "character": 0, + "url": "https://github.com/supabase/supabase-js/blob/4d7e616/src/lib/version.ts#L1" } ] } @@ -7381,8 +10429,7 @@ "groups": [ { "title": "Modules", - "kind": 2, - "children": [1, 10, 24, 53, 67, 128] + "children": [1, 20, 34, 63, 80, 144] } ] } diff --git a/apps/docs/spec/sections/generateMgmtApiSections.cts b/apps/docs/spec/sections/generateMgmtApiSections.cts index c235b7eccf2ef..02deb853df4e6 100644 --- a/apps/docs/spec/sections/generateMgmtApiSections.cts +++ b/apps/docs/spec/sections/generateMgmtApiSections.cts @@ -1,5 +1,5 @@ -const fs = require('fs') -const path = require('path') +import fs from 'fs' +import path from 'path' function slugToTitle(slug) { if (!slug) return '' diff --git a/apps/docs/spec/supabase_dart_v2.yml b/apps/docs/spec/supabase_dart_v2.yml index 6219bea93b790..0703f7f66c3e5 100644 --- a/apps/docs/spec/supabase_dart_v2.yml +++ b/apps/docs/spec/supabase_dart_v2.yml @@ -723,7 +723,7 @@ functions: name: Native Facebook Sign in description: | You can perform native Facebook sign in using [flutter_facebook_auth](https://pub.dev/packages/flutter_facebook_auth). - + First, set up your Facebook app in the [Facebook Developer Console](https://developers.facebook.com) and configure it in your Supabase dashboard under `Authentication -> Providers -> Facebook`. code: | ```dart diff --git a/apps/docs/spec/supabase_swift_v2.yml b/apps/docs/spec/supabase_swift_v2.yml index 9970a629f1209..b819da8f36b18 100644 --- a/apps/docs/spec/supabase_swift_v2.yml +++ b/apps/docs/spec/supabase_swift_v2.yml @@ -4856,7 +4856,7 @@ functions: code: | ```swift let fileData = "Hello World".data(using: .utf8)! - + try await supabase.storage .from("avatars") .uploadToSignedURL( @@ -4873,7 +4873,7 @@ functions: code: | ```swift let fileURL = URL(fileURLWithPath: "/path/to/file.txt") - + try await supabase.storage .from("avatars") .uploadToSignedURL( diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index 3334dd4470bae..ebd5c400200d9 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -66,20 +66,31 @@ } ], "paths": { - "/v1/branches/{branch_id}": { + "/v1/branches/{branch_id_or_ref}": { "get": { - "operationId": "v1-get-a-branch-config", - "summary": "Get database branch config", "description": "Fetches configurations of the specified database branch", + "operationId": "v1-get-a-branch-config", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -158,26 +169,38 @@ "description": "Failed to retrieve database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get database branch config", + "tags": ["Environments"] }, "patch": { - "operationId": "v1-update-a-branch-config", - "summary": "Update database branch config", "description": "Updates the configuration of the specified database branch", + "operationId": "v1-update-a-branch-config", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -282,6 +305,9 @@ "review_requested_at": { "type": "string", "format": "date-time" + }, + "with_data": { + "type": "boolean" } }, "required": [ @@ -293,7 +319,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] } } @@ -303,26 +330,38 @@ "description": "Failed to update database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Update database branch config", + "tags": ["Environments"] }, "delete": { - "operationId": "v1-delete-a-branch", - "summary": "Delete a database branch", "description": "Deletes the specified database branch", + "operationId": "v1-delete-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -348,28 +387,40 @@ "description": "Failed to delete database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Delete a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/push": { + "/v1/branches/{branch_id_or_ref}/push": { "post": { - "operationId": "v1-push-a-branch", - "summary": "Pushes a database branch", "description": "Pushes the specified database branch", + "operationId": "v1-push-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -413,28 +464,40 @@ "description": "Failed to push database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Pushes a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/merge": { + "/v1/branches/{branch_id_or_ref}/merge": { "post": { - "operationId": "v1-merge-a-branch", - "summary": "Merges a database branch", "description": "Merges the specified database branch", + "operationId": "v1-merge-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -478,28 +541,40 @@ "description": "Failed to merge database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Merges a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/reset": { + "/v1/branches/{branch_id_or_ref}/reset": { "post": { - "operationId": "v1-reset-a-branch", - "summary": "Resets a database branch", "description": "Resets the specified database branch", + "operationId": "v1-reset-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } } ], @@ -543,28 +618,40 @@ "description": "Failed to reset database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Resets a database branch", + "tags": ["Environments"] } }, - "/v1/branches/{branch_id}/diff": { + "/v1/branches/{branch_id_or_ref}/diff": { "get": { - "operationId": "v1-diff-a-branch", - "summary": "[Beta] Diffs a database branch", "description": "Diffs the specified database branch", + "operationId": "v1-diff-a-branch", "parameters": [ { - "name": "branch_id", + "name": "branch_id_or_ref", "required": true, "in": "path", "description": "Branch ID", "schema": { - "format": "uuid", - "type": "string" + "oneOf": [ + { + "type": "string", + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "description": "Project ref" + }, + { + "type": "string", + "format": "uuid", + "deprecated": true + } + ] } }, { @@ -591,19 +678,19 @@ "description": "Failed to diff database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Diffs a database branch", + "tags": ["Environments"] } }, "/v1/projects": { "get": { - "operationId": "v1-list-all-projects", - "summary": "List all projects", "description": "Returns a list of all projects you've previously created.", + "operationId": "v1-list-all-projects", "parameters": [], "responses": { "200": { @@ -695,16 +782,16 @@ } } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all projects", + "tags": ["Projects"] }, "post": { "operationId": "v1-create-a-project", - "summary": "Create a project", "parameters": [], "requestBody": { "required": true, @@ -857,19 +944,19 @@ } } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Create a project", + "tags": ["Projects"] } }, "/v1/organizations": { "get": { - "operationId": "v1-list-all-organizations", - "summary": "List all organizations", "description": "Returns a list of organizations that you currently belong to.", + "operationId": "v1-list-all-organizations", "parameters": [], "responses": { "200": { @@ -898,16 +985,16 @@ "description": "Unexpected error listing organizations" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all organizations", + "tags": ["Organizations"] }, "post": { "operationId": "v1-create-an-organization", - "summary": "Create an organization", "parameters": [], "requestBody": { "required": true, @@ -950,18 +1037,18 @@ "description": "Unexpected error creating an organization" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "Create an organization", + "tags": ["Organizations"] } }, "/v1/oauth/authorize": { "get": { "operationId": "v1-authorize-user", - "summary": "[Beta] Authorize user through oauth", "parameters": [ { "name": "client_id", @@ -977,8 +1064,8 @@ "required": true, "in": "query", "schema": { - "enum": ["code", "token", "id_token token"], - "type": "string" + "type": "string", + "enum": ["code", "token", "id_token token"] } }, { @@ -1026,8 +1113,8 @@ "required": false, "in": "query", "schema": { - "enum": ["plain", "sha256", "S256"], - "type": "string" + "type": "string", + "enum": ["plain", "sha256", "S256"] } }, { @@ -1046,8 +1133,8 @@ "in": "query", "description": "Resource indicator for MCP (Model Context Protocol) clients", "schema": { - "enum": ["https://api.supabase.io/mcp"], - "type": "string" + "type": "string", + "enum": ["https://api.supabase.io/mcp"] } } ], @@ -1056,18 +1143,18 @@ "description": "" } }, - "tags": ["OAuth"], "security": [ { "oauth2": ["read"] } - ] + ], + "summary": "[Beta] Authorize user through oauth", + "tags": ["OAuth"] } }, "/v1/oauth/token": { "post": { "operationId": "v1-exchange-oauth-token", - "summary": "[Beta] Exchange auth code for user's access and refresh token", "parameters": [], "requestBody": { "required": true, @@ -1139,18 +1226,18 @@ } } }, - "tags": ["OAuth"], "security": [ { "oauth2": ["write"] } - ] + ], + "summary": "[Beta] Exchange auth code for user's access and refresh token", + "tags": ["OAuth"] } }, "/v1/oauth/revoke": { "post": { "operationId": "v1-revoke-token", - "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", "parameters": [], "requestBody": { "required": true, @@ -1181,20 +1268,19 @@ "description": "" } }, - "tags": ["OAuth"], "security": [ { "oauth2": ["write"] } - ] + ], + "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", + "tags": ["OAuth"] } }, "/v1/oauth/authorize/project-claim": { "get": { - "operationId": "v1-oauth-authorize-project-claim", - "x-internal": true, - "summary": "Authorize user through oauth and claim a project", "description": "Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.", + "operationId": "v1-oauth-authorize-project-claim", "parameters": [ { "name": "project_ref", @@ -1222,8 +1308,8 @@ "required": true, "in": "query", "schema": { - "enum": ["code", "token", "id_token token"], - "type": "string" + "type": "string", + "enum": ["code", "token", "id_token token"] } }, { @@ -1263,8 +1349,8 @@ "required": false, "in": "query", "schema": { - "enum": ["plain", "sha256", "S256"], - "type": "string" + "type": "string", + "enum": ["plain", "sha256", "S256"] } } ], @@ -1273,18 +1359,19 @@ "description": "" } }, - "tags": ["OAuth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Authorize user through oauth and claim a project", + "tags": ["OAuth"], + "x-internal": true } }, "/v1/snippets": { "get": { "operationId": "v1-list-all-snippets", - "summary": "Lists SQL snippets for the logged in user", "parameters": [ { "name": "project_ref", @@ -1436,18 +1523,18 @@ "description": "Failed to list user's SQL snippets" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists SQL snippets for the logged in user", + "tags": ["Database"] } }, "/v1/snippets/{id}": { "get": { "operationId": "v1-get-a-snippet", - "summary": "Gets a specific SQL snippet", "parameters": [ { "name": "id", @@ -1564,18 +1651,18 @@ "description": "Failed to retrieve SQL snippet" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets a specific SQL snippet", + "tags": ["Database"] } }, "/v1/projects/{ref}/api-keys": { "get": { "operationId": "v1-get-project-api-keys", - "summary": "Get project api keys", "parameters": [ { "name": "ref", @@ -1663,16 +1750,16 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get project api keys", + "tags": ["Secrets"] }, "post": { "operationId": "v1-create-project-api-key", - "summary": "Creates a new API key for the project", "parameters": [ { "name": "ref", @@ -1789,18 +1876,18 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Creates a new API key for the project", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/api-keys/legacy": { "get": { "operationId": "v1-get-project-legacy-api-keys", - "summary": "Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -1836,16 +1923,16 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Secrets"] }, "put": { "operationId": "v1-update-project-legacy-api-keys", - "summary": "Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -1890,18 +1977,18 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/api-keys/{id}": { "patch": { "operationId": "v1-update-project-api-key", - "summary": "Updates an API key for the project", "parameters": [ { "name": "ref", @@ -2022,16 +2109,16 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates an API key for the project", + "tags": ["Secrets"] }, "get": { "operationId": "v1-get-project-api-key", - "summary": "Get API key", "parameters": [ { "name": "ref", @@ -2125,16 +2212,16 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get API key", + "tags": ["Secrets"] }, "delete": { "operationId": "v1-delete-project-api-key", - "summary": "Deletes an API key for the project", "parameters": [ { "name": "ref", @@ -2245,19 +2332,19 @@ "description": "" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Deletes an API key for the project", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/branches": { "get": { - "operationId": "v1-list-all-branches", - "summary": "List all database branches", "description": "Returns all database branches of the specified project.", + "operationId": "v1-list-all-branches", "parameters": [ { "name": "ref", @@ -2335,6 +2422,9 @@ "review_requested_at": { "type": "string", "format": "date-time" + }, + "with_data": { + "type": "boolean" } }, "required": [ @@ -2346,7 +2436,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] } } @@ -2360,17 +2451,17 @@ "description": "Failed to retrieve database branches" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all database branches", + "tags": ["Environments"] }, "post": { - "operationId": "v1-create-a-branch", - "summary": "Create a database branch", "description": "Creates a database branch from the specified project.", + "operationId": "v1-create-a-branch", "parameters": [ { "name": "ref", @@ -2519,6 +2610,9 @@ "review_requested_at": { "type": "string", "format": "date-time" + }, + "with_data": { + "type": "boolean" } }, "required": [ @@ -2530,7 +2624,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] } } @@ -2543,17 +2638,17 @@ "description": "Failed to create database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Create a database branch", + "tags": ["Environments"] }, "delete": { - "operationId": "v1-disable-preview-branching", - "summary": "Disables preview branching", "description": "Disables preview branching for the specified project", + "operationId": "v1-disable-preview-branching", "parameters": [ { "name": "ref", @@ -2579,19 +2674,19 @@ "description": "Failed to disable preview branching" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Disables preview branching", + "tags": ["Environments"] } }, "/v1/projects/{ref}/branches/{name}": { "get": { - "operationId": "v1-get-a-branch", - "summary": "Get a database branch", "description": "Fetches the specified database branch by its name.", + "operationId": "v1-get-a-branch", "parameters": [ { "name": "ref", @@ -2675,6 +2770,9 @@ "review_requested_at": { "type": "string", "format": "date-time" + }, + "with_data": { + "type": "boolean" } }, "required": [ @@ -2686,7 +2784,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] } } @@ -2699,18 +2798,18 @@ "description": "Failed to fetch database branch" } }, - "tags": ["Environments"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get a database branch", + "tags": ["Environments"] } }, "/v1/projects/{ref}/custom-hostname": { "get": { "operationId": "v1-get-hostname-config", - "summary": "[Beta] Gets project's custom hostname config", "parameters": [ { "name": "ref", @@ -2862,16 +2961,16 @@ "description": "Failed to retrieve project's custom hostname config" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets project's custom hostname config", + "tags": ["Domains"] }, "delete": { "operationId": "v1-Delete hostname config", - "summary": "[Beta] Deletes a project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -2897,18 +2996,18 @@ "description": "Failed to delete project custom hostname configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Deletes a project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/initialize": { "post": { "operationId": "v1-update-hostname-config", - "summary": "[Beta] Updates project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -2931,7 +3030,8 @@ "type": "object", "properties": { "custom_hostname": { - "type": "string" + "type": "string", + "minLength": 1 } }, "required": ["custom_hostname"] @@ -3076,18 +3176,18 @@ "description": "Failed to update project custom hostname configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Updates project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/reverify": { "post": { "operationId": "v1-verify-dns-config", - "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", "parameters": [ { "name": "ref", @@ -3239,18 +3339,18 @@ "description": "Failed to verify project custom hostname configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/custom-hostname/activate": { "post": { "operationId": "v1-activate-custom-hostname", - "summary": "[Beta] Activates a custom hostname for a project.", "parameters": [ { "name": "ref", @@ -3402,18 +3502,18 @@ "description": "Failed to activate project custom hostname configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Activates a custom hostname for a project.", + "tags": ["Domains"] } }, "/v1/projects/{ref}/network-bans/retrieve": { "post": { "operationId": "v1-list-all-network-bans", - "summary": "[Beta] Gets project's network bans", "parameters": [ { "name": "ref", @@ -3455,18 +3555,18 @@ "description": "Failed to retrieve project's network bans" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets project's network bans", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-bans/retrieve/enriched": { "post": { "operationId": "v1-list-all-network-bans-enriched", - "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", "parameters": [ { "name": "ref", @@ -3520,18 +3620,18 @@ "description": "Failed to retrieve project's enriched network bans" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-bans": { "delete": { "operationId": "v1-delete-network-bans", - "summary": "[Beta] Remove network bans.", "parameters": [ { "name": "ref", @@ -3557,7 +3657,13 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "List of IP addresses to unban." + }, + "requester_ip": { + "default": false, + "type": "boolean", + "description": "Include requester's public IP in the list of addresses to unban." }, "identifier": { "type": "string" @@ -3579,18 +3685,18 @@ "description": "Failed to remove network bans." } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Remove network bans.", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-restrictions": { "get": { "operationId": "v1-get-network-restrictions", - "summary": "[Beta] Gets project's network restrictions", "parameters": [ { "name": "ref", @@ -3656,6 +3762,14 @@ "status": { "type": "string", "enum": ["stored", "applied"] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "applied_at": { + "type": "string", + "format": "date-time" } }, "required": ["entitlement", "config", "status"] @@ -3670,18 +3784,169 @@ "description": "Failed to retrieve project's network restrictions" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets project's network restrictions", + "tags": ["Projects"] + }, + "patch": { + "operationId": "v1-patch-network-restrictions", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "add": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "string" + } + }, + "dbAllowedCidrsV6": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "remove": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "string" + } + }, + "dbAllowedCidrsV6": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "entitlement": { + "type": "string", + "enum": ["disallowed", "allowed"] + }, + "config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["v4", "v6"] + } + }, + "required": ["address", "type"] + } + } + }, + "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." + }, + "old_config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["v4", "v6"] + } + }, + "required": ["address", "type"] + } + } + }, + "description": "Populated when a new config has been received, but not registered as successfully applied to a project." + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "applied_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": ["stored", "applied"] + } + }, + "required": ["entitlement", "config", "status"] + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to update project network restrictions" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "[Alpha] Updates project's network restrictions by adding or removing CIDRs", + "tags": ["Projects"] } }, "/v1/projects/{ref}/network-restrictions/apply": { "post": { "operationId": "v1-update-network-restrictions", - "summary": "[Beta] Updates project's network restrictions", "parameters": [ { "name": "ref", @@ -3771,6 +4036,14 @@ "status": { "type": "string", "enum": ["stored", "applied"] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "applied_at": { + "type": "string", + "format": "date-time" } }, "required": ["entitlement", "config", "status"] @@ -3785,18 +4058,18 @@ "description": "Failed to update project network restrictions" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Updates project's network restrictions", + "tags": ["Projects"] } }, "/v1/projects/{ref}/pgsodium": { "get": { "operationId": "v1-get-pgsodium-config", - "summary": "[Beta] Gets project's pgsodium config", "parameters": [ { "name": "ref", @@ -3835,16 +4108,16 @@ "description": "Failed to retrieve project's pgsodium config" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets project's pgsodium config", + "tags": ["Secrets"] }, "put": { "operationId": "v1-update-pgsodium-config", - "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", "parameters": [ { "name": "ref", @@ -3899,18 +4172,18 @@ "description": "Failed to update project's pgsodium config" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/postgrest": { "get": { "operationId": "v1-get-postgrest-service-config", - "summary": "Gets project's postgrest config", "parameters": [ { "name": "ref", @@ -3963,16 +4236,16 @@ "description": "Failed to retrieve project's postgrest config" } }, - "tags": ["Rest"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's postgrest config", + "tags": ["Rest"] }, "patch": { "operationId": "v1-update-postgrest-service-config", - "summary": "Updates project's postgrest config", "parameters": [ { "name": "ref", @@ -4050,18 +4323,18 @@ "description": "Failed to update project's postgrest config" } }, - "tags": ["Rest"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates project's postgrest config", + "tags": ["Rest"] } }, "/v1/projects/{ref}": { "get": { "operationId": "v1-get-project", - "summary": "Gets a specific project that belongs to the authenticated user", "parameters": [ { "name": "ref", @@ -4169,16 +4442,16 @@ "description": "Failed to retrieve project" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets a specific project that belongs to the authenticated user", + "tags": ["Projects"] }, "delete": { "operationId": "v1-delete-a-project", - "summary": "Deletes the given project", "parameters": [ { "name": "ref", @@ -4220,19 +4493,19 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Deletes the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/secrets": { "get": { - "operationId": "v1-list-all-secrets", - "summary": "List all secrets", "description": "Returns all secrets you've previously added to the specified project.", + "operationId": "v1-list-all-secrets", "parameters": [ { "name": "ref", @@ -4280,17 +4553,17 @@ "description": "Failed to retrieve project's secrets" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all secrets", + "tags": ["Secrets"] }, "post": { - "operationId": "v1-bulk-create-secrets", - "summary": "Bulk create secrets", "description": "Creates multiple secrets and adds them to the specified project.", + "operationId": "v1-bulk-create-secrets", "parameters": [ { "name": "ref", @@ -4343,17 +4616,17 @@ "description": "Failed to create project's secrets" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Bulk create secrets", + "tags": ["Secrets"] }, "delete": { - "operationId": "v1-bulk-delete-secrets", - "summary": "Bulk delete secrets", "description": "Deletes all secrets with the given names from the specified project", + "operationId": "v1-bulk-delete-secrets", "parameters": [ { "name": "ref", @@ -4392,18 +4665,18 @@ "description": "Failed to delete secrets with given names" } }, - "tags": ["Secrets"], "security": [ { "bearer": [] } - ] + ], + "summary": "Bulk delete secrets", + "tags": ["Secrets"] } }, "/v1/projects/{ref}/ssl-enforcement": { "get": { "operationId": "v1-get-ssl-enforcement-config", - "summary": "[Beta] Get project's SSL enforcement configuration.", "parameters": [ { "name": "ref", @@ -4451,16 +4724,16 @@ "description": "Failed to retrieve project's SSL enforcement config" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Get project's SSL enforcement configuration.", + "tags": ["Database"] }, "put": { "operationId": "v1-update-ssl-enforcement-config", - "summary": "[Beta] Update project's SSL enforcement configuration.", "parameters": [ { "name": "ref", @@ -4530,19 +4803,19 @@ "description": "Failed to update project's SSL enforcement configuration." } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Update project's SSL enforcement configuration.", + "tags": ["Database"] } }, "/v1/projects/{ref}/types/typescript": { "get": { - "operationId": "v1-generate-typescript-types", - "summary": "Generate TypeScript types", "description": "Returns the TypeScript types of your schema for use with supabase-js.", + "operationId": "v1-generate-typescript-types", "parameters": [ { "name": "included_schemas", @@ -4590,18 +4863,18 @@ "description": "Failed to generate TypeScript types" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Generate TypeScript types", + "tags": ["Database"] } }, "/v1/projects/{ref}/vanity-subdomain": { "get": { "operationId": "v1-get-vanity-subdomain-config", - "summary": "[Beta] Gets current vanity subdomain config", "parameters": [ { "name": "ref", @@ -4629,7 +4902,8 @@ "enum": ["not-used", "custom-domain-used", "active"] }, "custom_domain": { - "type": "string" + "type": "string", + "minLength": 1 } }, "required": ["status"] @@ -4644,16 +4918,16 @@ "description": "Failed to get project vanity subdomain configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets current vanity subdomain config", + "tags": ["Domains"] }, "delete": { "operationId": "v1-deactivate-vanity-subdomain-config", - "summary": "[Beta] Deletes a project's vanity subdomain configuration", "parameters": [ { "name": "ref", @@ -4679,18 +4953,18 @@ "description": "Failed to delete project vanity subdomain configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Deletes a project's vanity subdomain configuration", + "tags": ["Domains"] } }, "/v1/projects/{ref}/vanity-subdomain/check-availability": { "post": { "operationId": "v1-check-vanity-subdomain-availability", - "summary": "[Beta] Checks vanity subdomain availability", "parameters": [ { "name": "ref", @@ -4745,18 +5019,18 @@ "description": "Failed to check project vanity subdomain configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Checks vanity subdomain availability", + "tags": ["Domains"] } }, "/v1/projects/{ref}/vanity-subdomain/activate": { "post": { "operationId": "v1-activate-vanity-subdomain-config", - "summary": "[Beta] Activates a vanity subdomain for a project.", "parameters": [ { "name": "ref", @@ -4811,18 +5085,18 @@ "description": "Failed to activate project vanity subdomain configuration" } }, - "tags": ["Domains"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Activates a vanity subdomain for a project.", + "tags": ["Domains"] } }, "/v1/projects/{ref}/upgrade": { "post": { "operationId": "v1-upgrade-postgres-version", - "summary": "[Beta] Upgrades the project's Postgres version", "parameters": [ { "name": "ref", @@ -4881,18 +5155,18 @@ "description": "Failed to initiate project upgrade" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Upgrades the project's Postgres version", + "tags": ["Projects"] } }, "/v1/projects/{ref}/upgrade/eligibility": { "get": { "operationId": "v1-get-postgres-upgrade-eligibility", - "summary": "[Beta] Returns the project's eligibility for upgrades", "parameters": [ { "name": "ref", @@ -4999,18 +5273,18 @@ "description": "Failed to determine project upgrade eligibility" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Returns the project's eligibility for upgrades", + "tags": ["Projects"] } }, "/v1/projects/{ref}/upgrade/status": { "get": { "operationId": "v1-get-postgres-upgrade-status", - "summary": "[Beta] Gets the latest status of the project's upgrade", "parameters": [ { "name": "ref", @@ -5103,18 +5377,18 @@ "description": "Failed to retrieve project upgrade status" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Gets the latest status of the project's upgrade", + "tags": ["Projects"] } }, "/v1/projects/{ref}/readonly": { "get": { "operationId": "v1-get-readonly-mode-status", - "summary": "Returns project's readonly mode status", "parameters": [ { "name": "ref", @@ -5159,18 +5433,18 @@ "description": "Failed to get project readonly mode status" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Returns project's readonly mode status", + "tags": ["Database"] } }, "/v1/projects/{ref}/readonly/temporary-disable": { "post": { "operationId": "v1-disable-readonly-mode-temporarily", - "summary": "Disables project's readonly mode for the next 15 minutes", "parameters": [ { "name": "ref", @@ -5196,18 +5470,18 @@ "description": "Failed to disable project's readonly mode" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Disables project's readonly mode for the next 15 minutes", + "tags": ["Database"] } }, "/v1/projects/{ref}/read-replicas/setup": { "post": { "operationId": "v1-setup-a-read-replica", - "summary": "[Beta] Set up a read replica", "parameters": [ { "name": "ref", @@ -5271,18 +5545,18 @@ "description": "Failed to set up read replica" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Set up a read replica", + "tags": ["Database"] } }, "/v1/projects/{ref}/read-replicas/remove": { "post": { "operationId": "v1-remove-a-read-replica", - "summary": "[Beta] Remove a read replica", "parameters": [ { "name": "ref", @@ -5324,18 +5598,18 @@ "description": "Failed to remove read replica" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Remove a read replica", + "tags": ["Database"] } }, "/v1/projects/{ref}/health": { "get": { "operationId": "v1-get-services-health", - "summary": "Gets project's service health status", "parameters": [ { "name": "ref", @@ -5357,7 +5631,16 @@ "type": "array", "items": { "type": "string", - "enum": ["auth", "db", "pooler", "realtime", "rest", "storage"] + "enum": [ + "auth", + "db", + "db_postgres_user", + "pooler", + "realtime", + "rest", + "storage", + "pg_bouncer" + ] } } }, @@ -5384,7 +5667,16 @@ "properties": { "name": { "type": "string", - "enum": ["auth", "db", "pooler", "realtime", "rest", "storage"] + "enum": [ + "auth", + "db", + "db_postgres_user", + "pooler", + "realtime", + "rest", + "storage", + "pg_bouncer" + ] }, "healthy": { "type": "boolean" @@ -5445,18 +5737,18 @@ "description": "Failed to retrieve project's service health status" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's service health status", + "tags": ["Projects"] } }, "/v1/projects/{ref}/config/auth/signing-keys/legacy": { "post": { "operationId": "v1-create-legacy-signing-key", - "summary": "Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -5513,16 +5805,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-legacy-signing-key", - "summary": "Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.", "parameters": [ { "name": "ref", @@ -5579,18 +5871,18 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/signing-keys": { "post": { "operationId": "v1-create-project-signing-key", - "summary": "Create a new signing key for the project in standby status", "parameters": [ { "name": "ref", @@ -5772,16 +6064,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Create a new signing key for the project in standby status", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-project-signing-keys", - "summary": "List all signing keys for the project", "parameters": [ { "name": "ref", @@ -5848,18 +6140,18 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all signing keys for the project", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/signing-keys/{id}": { "get": { "operationId": "v1-get-project-signing-key", - "summary": "Get information about a signing key", "parameters": [ { "name": "id", @@ -5925,16 +6217,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get information about a signing key", + "tags": ["Auth"] }, "delete": { "operationId": "v1-remove-project-signing-key", - "summary": "Remove a signing key from a project. Only possible if the key has been in revoked status for a while.", "parameters": [ { "name": "id", @@ -6000,16 +6292,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Remove a signing key from a project. Only possible if the key has been in revoked status for a while.", + "tags": ["Auth"] }, "patch": { "operationId": "v1-update-project-signing-key", - "summary": "Update a signing key, mainly its status", "parameters": [ { "name": "id", @@ -6093,18 +6385,18 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Update a signing key, mainly its status", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/storage": { "get": { "operationId": "v1-get-storage-config", - "summary": "Gets project's storage config", "parameters": [ { "name": "ref", @@ -6163,9 +6455,31 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "capabilities": { + "type": "object", + "properties": { + "list_v2": { + "type": "boolean" + }, + "iceberg_catalog": { + "type": "boolean" + } + }, + "required": ["list_v2", "iceberg_catalog"] + }, + "external": { + "type": "object", + "properties": { + "upstreamTarget": { + "type": "string", + "enum": ["main", "canary"] + } + }, + "required": ["upstreamTarget"] } }, - "required": ["fileSizeLimit", "features"] + "required": ["fileSizeLimit", "features", "capabilities", "external"] } } } @@ -6177,16 +6491,16 @@ "description": "Failed to retrieve project's storage config" } }, - "tags": ["Storage"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's storage config", + "tags": ["Storage"] }, "patch": { "operationId": "v1-update-storage-config", - "summary": "Updates project's storage config", "parameters": [ { "name": "ref", @@ -6246,8 +6560,19 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "external": { + "type": "object", + "properties": { + "upstreamTarget": { + "type": "string", + "enum": ["main", "canary"] + } + }, + "required": ["upstreamTarget"] } - } + }, + "additionalProperties": false } } } @@ -6263,18 +6588,18 @@ "description": "Failed to update project's storage config" } }, - "tags": ["Storage"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates project's storage config", + "tags": ["Storage"] } }, "/v1/projects/{ref}/config/database/postgres": { "get": { "operationId": "v1-get-postgres-config", - "summary": "Gets project's Postgres config", "parameters": [ { "name": "ref", @@ -6391,16 +6716,16 @@ "description": "Failed to retrieve project's Postgres config" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's Postgres config", + "tags": ["Database"] }, "put": { "operationId": "v1-update-postgres-config", - "summary": "Updates project's Postgres config", "parameters": [ { "name": "ref", @@ -6507,7 +6832,8 @@ "restart_database": { "type": "boolean" } - } + }, + "additionalProperties": false } } } @@ -6614,18 +6940,18 @@ "description": "Failed to update project's Postgres config" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates project's Postgres config", + "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pgbouncer": { "get": { "operationId": "v1-get-project-pgbouncer-config", - "summary": "Get project's pgbouncer config", "parameters": [ { "name": "ref", @@ -6688,13 +7014,13 @@ "description": "Failed to retrieve project's pgbouncer config" } }, + "summary": "Get project's pgbouncer config", "tags": ["Database"] } }, "/v1/projects/{ref}/config/database/pooler": { "get": { "operationId": "v1-get-pooler-config", - "summary": "Gets project's supavisor config", "parameters": [ { "name": "ref", @@ -6780,20 +7106,23 @@ } } }, + "403": { + "description": "" + }, "500": { "description": "Failed to retrieve project's supavisor config" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's supavisor config", + "tags": ["Database"] }, "patch": { "operationId": "v1-update-pooler-config", - "summary": "Updates project's supavisor config", "parameters": [ { "name": "ref", @@ -6859,18 +7188,18 @@ "description": "Failed to update project's supavisor config" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates project's supavisor config", + "tags": ["Database"] } }, "/v1/projects/{ref}/config/auth": { "get": { "operationId": "v1-get-auth-service-config", - "summary": "Gets project's auth config", "parameters": [ { "name": "ref", @@ -7177,6 +7506,10 @@ "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { + "type": "boolean", + "nullable": true + }, "external_zoom_client_id": { "type": "string", "nullable": true @@ -7371,6 +7704,14 @@ "type": "integer", "nullable": true }, + "nimbus_oauth_client_id": { + "type": "string", + "nullable": true + }, + "nimbus_oauth_client_secret": { + "type": "string", + "nullable": true + }, "password_hibp_enabled": { "type": "boolean", "nullable": true @@ -7673,6 +8014,7 @@ "external_workos_secret", "external_workos_url", "external_web3_solana_enabled", + "external_web3_ethereum_enabled", "external_zoom_client_id", "external_zoom_enabled", "external_zoom_secret", @@ -7722,6 +8064,8 @@ "mfa_phone_otp_length", "mfa_phone_template", "mfa_phone_max_frequency", + "nimbus_oauth_client_id", + "nimbus_oauth_client_secret", "password_hibp_enabled", "password_min_length", "password_required_characters", @@ -7789,16 +8133,16 @@ "description": "Failed to retrieve project's auth config" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's auth config", + "tags": ["Auth"] }, "patch": { "operationId": "v1-update-auth-service-config", - "summary": "Updates a project's auth config", "parameters": [ { "name": "ref", @@ -8508,6 +8852,10 @@ "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { + "type": "boolean", + "nullable": true + }, "external_zoom_enabled": { "type": "boolean", "nullable": true @@ -8567,6 +8915,14 @@ "mfa_phone_template": { "type": "string", "nullable": true + }, + "nimbus_oauth_client_id": { + "type": "string", + "nullable": true + }, + "nimbus_oauth_client_secret": { + "type": "string", + "nullable": true } } } @@ -8865,6 +9221,10 @@ "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { + "type": "boolean", + "nullable": true + }, "external_zoom_client_id": { "type": "string", "nullable": true @@ -9059,6 +9419,14 @@ "type": "integer", "nullable": true }, + "nimbus_oauth_client_id": { + "type": "string", + "nullable": true + }, + "nimbus_oauth_client_secret": { + "type": "string", + "nullable": true + }, "password_hibp_enabled": { "type": "boolean", "nullable": true @@ -9361,6 +9729,7 @@ "external_workos_secret", "external_workos_url", "external_web3_solana_enabled", + "external_web3_ethereum_enabled", "external_zoom_client_id", "external_zoom_enabled", "external_zoom_secret", @@ -9410,6 +9779,8 @@ "mfa_phone_otp_length", "mfa_phone_template", "mfa_phone_max_frequency", + "nimbus_oauth_client_id", + "nimbus_oauth_client_secret", "password_hibp_enabled", "password_min_length", "password_required_characters", @@ -9477,18 +9848,18 @@ "description": "Failed to update project's auth config" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates a project's auth config", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/third-party-auth": { "post": { "operationId": "v1-create-project-tpa-integration", - "summary": "Creates a new third-party auth integration", "parameters": [ { "name": "ref", @@ -9571,16 +9942,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Creates a new third-party auth integration", + "tags": ["Auth"] }, "get": { "operationId": "v1-list-project-tpa-integrations", - "summary": "Lists all third-party auth integrations", "parameters": [ { "name": "ref", @@ -9647,18 +10018,18 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists all third-party auth integrations", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}": { "delete": { "operationId": "v1-delete-project-tpa-integration", - "summary": "Removes a third-party auth integration", "parameters": [ { "name": "ref", @@ -9731,16 +10102,16 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Removes a third-party auth integration", + "tags": ["Auth"] }, "get": { "operationId": "v1-get-project-tpa-integration", - "summary": "Get a third-party integration", "parameters": [ { "name": "ref", @@ -9813,18 +10184,18 @@ "description": "" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get a third-party integration", + "tags": ["Auth"] } }, "/v1/projects/{ref}/pause": { "post": { "operationId": "v1-pause-a-project", - "summary": "Pauses the given project", "parameters": [ { "name": "ref", @@ -9847,18 +10218,18 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Pauses the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/restore": { "get": { "operationId": "v1-list-available-restore-versions", - "summary": "Lists available restore versions for the given project", "parameters": [ { "name": "ref", @@ -9911,16 +10282,16 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists available restore versions for the given project", + "tags": ["Projects"] }, "post": { "operationId": "v1-restore-a-project", - "summary": "Restores the given project", "parameters": [ { "name": "ref", @@ -9943,18 +10314,18 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Restores the given project", + "tags": ["Projects"] } }, "/v1/projects/{ref}/restore/cancel": { "post": { "operationId": "v1-cancel-a-project-restoration", - "summary": "Cancels the given project restoration", "parameters": [ { "name": "ref", @@ -9977,18 +10348,18 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Cancels the given project restoration", + "tags": ["Projects"] } }, "/v1/projects/{ref}/billing/addons": { "get": { "operationId": "v1-list-project-addons", - "summary": "Lists project addons", "parameters": [ { "name": "ref", @@ -10238,16 +10609,16 @@ "description": "Failed to list project addons" } }, - "tags": ["Billing"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists project addons", + "tags": ["Billing"] }, "patch": { "operationId": "v1-apply-project-addon", - "summary": "Applies project addon", "parameters": [ { "name": "ref", @@ -10337,18 +10708,18 @@ "description": "Failed to apply project addon" } }, - "tags": ["Billing"], "security": [ { "bearer": [] } - ] + ], + "summary": "Applies project addon", + "tags": ["Billing"] } }, "/v1/projects/{ref}/billing/addons/{addon_variant}": { "delete": { "operationId": "v1-remove-project-addon", - "summary": "Removes project addon", "parameters": [ { "name": "ref", @@ -10366,46 +10737,47 @@ "name": "addon_variant", "required": true, "in": "path", - "oneOf": [ - { - "type": "string", - "enum": [ - "ci_micro", - "ci_small", - "ci_medium", - "ci_large", - "ci_xlarge", - "ci_2xlarge", - "ci_4xlarge", - "ci_8xlarge", - "ci_12xlarge", - "ci_16xlarge", - "ci_24xlarge", - "ci_24xlarge_optimized_cpu", - "ci_24xlarge_optimized_memory", - "ci_24xlarge_high_memory", - "ci_48xlarge", - "ci_48xlarge_optimized_cpu", - "ci_48xlarge_optimized_memory", - "ci_48xlarge_high_memory" - ] - }, - { - "type": "string", - "enum": ["cd_default"] - }, - { - "type": "string", - "enum": ["pitr_7", "pitr_14", "pitr_28"] - }, - { - "type": "string", - "enum": ["ipv4_default"] - } - ], - "schema": {} - } - ], + "schema": { + "oneOf": [ + { + "type": "string", + "enum": [ + "ci_micro", + "ci_small", + "ci_medium", + "ci_large", + "ci_xlarge", + "ci_2xlarge", + "ci_4xlarge", + "ci_8xlarge", + "ci_12xlarge", + "ci_16xlarge", + "ci_24xlarge", + "ci_24xlarge_optimized_cpu", + "ci_24xlarge_optimized_memory", + "ci_24xlarge_high_memory", + "ci_48xlarge", + "ci_48xlarge_optimized_cpu", + "ci_48xlarge_optimized_memory", + "ci_48xlarge_high_memory" + ] + }, + { + "type": "string", + "enum": ["cd_default"] + }, + { + "type": "string", + "enum": ["pitr_7", "pitr_14", "pitr_28"] + }, + { + "type": "string", + "enum": ["ipv4_default"] + } + ] + } + } + ], "responses": { "200": { "description": "" @@ -10417,19 +10789,18 @@ "description": "Failed to remove project addon" } }, - "tags": ["Billing"], "security": [ { "bearer": [] } - ] + ], + "summary": "Removes project addon", + "tags": ["Billing"] } }, "/v1/projects/{ref}/claim-token": { "get": { "operationId": "v1-get-project-claim-token", - "x-internal": true, - "summary": "Gets project claim token", "parameters": [ { "name": "ref", @@ -10475,17 +10846,17 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project claim token", + "tags": ["Projects"], + "x-internal": true }, "post": { "operationId": "v1-create-project-claim-token", - "x-internal": true, - "summary": "Creates project claim token", "parameters": [ { "name": "ref", @@ -10534,17 +10905,17 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Creates project claim token", + "tags": ["Projects"], + "x-internal": true }, "delete": { "operationId": "v1-delete-project-claim-token", - "x-internal": true, - "summary": "Revokes project claim token", "parameters": [ { "name": "ref", @@ -10567,20 +10938,21 @@ "description": "" } }, - "tags": ["Projects"], "security": [ { "bearer": [] } - ] + ], + "summary": "Revokes project claim token", + "tags": ["Projects"], + "x-internal": true } }, "/v1/projects/{ref}/advisors/performance": { "get": { - "operationId": "v1-get-performance-advisors", - "summary": "Gets project performance advisors.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-performance-advisors", "parameters": [ { "name": "ref", @@ -10638,7 +11010,8 @@ "auth_insufficient_mfa_options", "auth_password_policy_missing", "leaked_service_key", - "no_backup_admin" + "no_backup_admin", + "vulnerable_postgres_version" ] }, "title": { @@ -10729,20 +11102,20 @@ "description": "" } }, - "tags": ["Advisors"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project performance advisors.", + "tags": ["Advisors"] } }, "/v1/projects/{ref}/advisors/security": { "get": { - "operationId": "v1-get-security-advisors", - "summary": "Gets project security advisors.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-security-advisors", "parameters": [ { "name": "ref", @@ -10761,8 +11134,8 @@ "required": false, "in": "query", "schema": { - "enum": ["sql"], - "type": "string" + "type": "string", + "enum": ["sql"] } } ], @@ -10809,7 +11182,8 @@ "auth_insufficient_mfa_options", "auth_password_policy_missing", "leaked_service_key", - "no_backup_admin" + "no_backup_admin", + "vulnerable_postgres_version" ] }, "title": { @@ -10900,19 +11274,19 @@ "description": "" } }, - "tags": ["Advisors"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project security advisors.", + "tags": ["Advisors"] } }, "/v1/projects/{ref}/analytics/endpoints/logs.all": { "get": { - "operationId": "v1-get-project-logs", - "summary": "Gets project's logs", "description": "Executes a SQL query on the project's logs.\n\nEither the 'iso_timestamp_start' and 'iso_timestamp_end' parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n", + "operationId": "v1-get-project-logs", "parameters": [ { "name": "ref", @@ -11026,18 +11400,18 @@ "description": "" } }, - "tags": ["Analytics"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's logs", + "tags": ["Analytics"] } }, "/v1/projects/{ref}/analytics/endpoints/usage.api-counts": { "get": { "operationId": "v1-get-project-usage-api-count", - "summary": "Gets project's usage api counts", "parameters": [ { "name": "ref", @@ -11056,8 +11430,8 @@ "required": false, "in": "query", "schema": { - "enum": ["15min", "30min", "1hr", "3hr", "1day", "3day", "7day"], - "type": "string" + "type": "string", + "enum": ["15min", "30min", "1hr", "3hr", "1day", "3day", "7day"] } } ], @@ -11071,7 +11445,34 @@ "properties": { "result": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "total_auth_requests": { + "type": "number" + }, + "total_realtime_requests": { + "type": "number" + }, + "total_rest_requests": { + "type": "number" + }, + "total_storage_requests": { + "type": "number" + } + }, + "required": [ + "timestamp", + "total_auth_requests", + "total_realtime_requests", + "total_rest_requests", + "total_storage_requests" + ] + } }, "error": { "oneOf": [ @@ -11137,18 +11538,18 @@ "description": "Failed to get project's usage api counts" } }, - "tags": ["Analytics"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's usage api counts", + "tags": ["Analytics"] } }, "/v1/projects/{ref}/analytics/endpoints/usage.api-requests-count": { "get": { "operationId": "v1-get-project-usage-request-count", - "summary": "Gets project's usage api requests count", "parameters": [ { "name": "ref", @@ -11173,7 +11574,15 @@ "properties": { "result": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "count": { + "type": "number" + } + }, + "required": ["count"] + } }, "error": { "oneOf": [ @@ -11232,23 +11641,25 @@ } } }, + "403": { + "description": "" + }, "500": { "description": "Failed to get project's usage api requests count" } }, - "tags": ["Analytics"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project's usage api requests count", + "tags": ["Analytics"] } }, - "/v1/projects/{ref}/database/migrations": { + "/v1/projects/{ref}/analytics/endpoints/functions.combined-stats": { "get": { - "operationId": "v1-list-migration-history", - "summary": "[Beta] List applied migration versions", - "description": "Only available to selected partner OAuth apps", + "operationId": "v1-get-project-function-combined-stats", "parameters": [ { "name": "ref", @@ -11261,6 +11672,23 @@ "pattern": "^[a-z]+$", "type": "string" } + }, + { + "name": "interval", + "required": true, + "in": "query", + "schema": { + "type": "string", + "enum": ["15min", "1hr", "3hr", "1day"] + } + }, + { + "name": "function_id", + "required": true, + "in": "query", + "schema": { + "type": "string" + } } ], "responses": { @@ -11269,19 +11697,64 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "version": { - "type": "string", - "minLength": 1 - }, - "name": { - "type": "string" - } + "type": "object", + "properties": { + "result": { + "type": "array", + "items": {} }, - "required": ["version"] + "error": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "location": { + "type": "string" + }, + "locationType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "required": [ + "domain", + "location", + "locationType", + "message", + "reason" + ] + } + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": ["code", "errors", "message", "status"] + } + ] + } } } } @@ -11291,20 +11764,21 @@ "description": "" }, "500": { - "description": "Failed to list database migrations" + "description": "Failed to get project's function combined statistics" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] - }, + ], + "summary": "Gets a project's function combined statistics", + "tags": ["Analytics"] + } + }, + "/v1/projects/{ref}/cli/login-role": { "post": { - "operationId": "v1-apply-a-migration", - "summary": "[Beta] Apply a database migration", - "description": "Only available to selected partner OAuth apps", + "operationId": "v1-create-login-role", "parameters": [ { "name": "ref", @@ -11317,15 +11791,6 @@ "pattern": "^[a-z]+$", "type": "string" } - }, - { - "name": "Idempotency-Key", - "required": false, - "in": "header", - "description": "A unique key to ensure the same migration is tracked only once.", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -11335,41 +11800,59 @@ "schema": { "type": "object", "properties": { - "query": { - "type": "string", - "minLength": 1 - }, - "name": { - "type": "string" + "read_only": { + "type": "boolean" } }, - "required": ["query"] + "required": ["read_only"] } } } }, "responses": { - "200": { - "description": "" + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "password": { + "type": "string", + "minLength": 1 + }, + "ttl_seconds": { + "type": "integer", + "minimum": 1, + "format": "int64" + } + }, + "required": ["role", "password", "ttl_seconds"] + } + } + } }, "403": { "description": "" }, "500": { - "description": "Failed to apply database migration" + "description": "Failed to create login role" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Create a login role for CLI with temporary password", + "tags": ["Database"] }, - "put": { - "operationId": "v1-upsert-a-migration", - "summary": "[Beta] Upsert a database migration without applying", - "description": "Only available to selected partner OAuth apps", + "delete": { + "operationId": "v1-delete-login-roles", "parameters": [ { "name": "ref", @@ -11382,15 +11865,188 @@ "pattern": "^[a-z]+$", "type": "string" } - }, - { - "name": "Idempotency-Key", - "required": false, - "in": "header", - "description": "A unique key to ensure the same migration is tracked only once.", - "schema": { - "type": "string" - } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "enum": ["ok"] + } + }, + "required": ["message"] + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to delete login roles" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "[Beta] Delete existing login roles used by CLI", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/migrations": { + "get": { + "description": "Only available to selected partner OAuth apps", + "operationId": "v1-list-migration-history", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "version": { + "type": "string", + "minLength": 1 + }, + "name": { + "type": "string" + } + }, + "required": ["version"] + } + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to list database migrations" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "[Beta] List applied migration versions", + "tags": ["Database"] + }, + "post": { + "description": "Only available to selected partner OAuth apps", + "operationId": "v1-apply-a-migration", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + }, + { + "name": "Idempotency-Key", + "required": false, + "in": "header", + "description": "A unique key to ensure the same migration is tracked only once.", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "query": { + "type": "string", + "minLength": 1 + }, + "name": { + "type": "string" + } + }, + "required": ["query"] + } + } + } + }, + "responses": { + "200": { + "description": "" + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to apply database migration" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "[Beta] Apply a database migration", + "tags": ["Database"] + }, + "put": { + "description": "Only available to selected partner OAuth apps", + "operationId": "v1-upsert-a-migration", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + }, + { + "name": "Idempotency-Key", + "required": false, + "in": "header", + "description": "A unique key to ensure the same migration is tracked only once.", + "schema": { + "type": "string" + } } ], "requestBody": { @@ -11424,18 +12080,18 @@ "description": "Failed to upsert database migration" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Upsert a database migration without applying", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/query": { "post": { "operationId": "v1-run-a-query", - "summary": "[Beta] Run sql query", "parameters": [ { "name": "ref", @@ -11481,18 +12137,57 @@ "description": "Failed to run sql query" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "[Beta] Run sql query", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/webhooks/enable": { "post": { "operationId": "v1-enable-database-webhook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "" + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to enable Database Webhooks on the project" + } + }, + "security": [ + { + "bearer": [] + } + ], "summary": "[Beta] Enables Database Webhooks on the project", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/context": { + "get": { + "deprecated": true, + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", + "operationId": "v1-get-database-metadata", "parameters": [ { "name": "ref", @@ -11505,33 +12200,433 @@ "pattern": "^[a-z]+$", "type": "string" } - } - ], - "responses": { - "201": { - "description": "" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "databases": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "schemas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": ["name"], + "additionalProperties": true + } + } + }, + "required": ["name", "schemas"], + "additionalProperties": true + } + } + }, + "required": ["databases"] + } + } + } + }, + "403": { + "description": "" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Gets database metadata for the given project.", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/jit": { + "get": { + "description": "Mappings of roles a user can assume in the project database", + "operationId": "v1-get-jit-access", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to list database jit access" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Get user-id to role mappings for JIT access", + "tags": ["Database"] + }, + "post": { + "description": "Authorizes the request to assume a role in the project database", + "operationId": "v1-authorize-jit-access", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "rhost": { + "type": "string", + "minLength": 1 + } + }, + "required": ["role", "rhost"] + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_role": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + }, + "required": ["user_id", "user_role"] + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to authorize database jit access" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Authorize user-id to role mappings for JIT access", + "tags": ["Database"] + }, + "put": { + "description": "Modifies the roles that can be assumed and for how long", + "operationId": "v1-update-jit-access", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid", + "minLength": 1 + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "roles"] + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + } + } + } }, "403": { "description": "" }, "500": { - "description": "Failed to enable Database Webhooks on the project" + "description": "Failed to upsert database migration" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates a user mapping for JIT access", + "tags": ["Database"] } }, - "/v1/projects/{ref}/database/context": { + "/v1/projects/{ref}/database/jit/list": { "get": { - "operationId": "v1-get-database-metadata", - "summary": "Gets database metadata for the given project.", - "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", - "deprecated": true, + "description": "Mappings of roles a user can assume in the project database", + "operationId": "v1-list-jit-access", "parameters": [ { "name": "ref", @@ -11554,55 +12649,137 @@ "schema": { "type": "object", "properties": { - "databases": { + "items": { "type": "array", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "user_id": { + "type": "string", + "format": "uuid" }, - "schemas": { + "user_roles": { "type": "array", "items": { "type": "object", "properties": { - "name": { - "type": "string" + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } } }, - "required": ["name"], - "additionalProperties": true + "required": ["role"] } } }, - "required": ["name", "schemas"], - "additionalProperties": true + "required": ["user_id", "user_roles"] } } }, - "required": ["databases"] + "required": ["items"] } } } }, "403": { "description": "" + }, + "500": { + "description": "Failed to list database jit access" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all user-id to role mappings for JIT access", + "tags": ["Database"] + } + }, + "/v1/projects/{ref}/database/jit/{user_id}": { + "delete": { + "description": "Remove JIT mappings of a user, revoking all JIT database access", + "operationId": "v1-delete-jit-access", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "type": "string" + } + }, + { + "name": "user_id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to remove JIT access" + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Delete JIT access by user-id", + "tags": ["Database"] } }, "/v1/projects/{ref}/functions": { "get": { - "operationId": "v1-list-all-functions", - "summary": "List all functions", "description": "Returns all functions you've previously added to the specified project.", + "operationId": "v1-list-all-functions", "parameters": [ { "name": "ref", @@ -11688,50 +12865,18 @@ "description": "Failed to retrieve project's functions" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "List all functions", + "tags": ["Edge Functions"] }, "post": { - "operationId": "v1-create-a-function", - "summary": "Create a function", - "description": "This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.", "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/vnd.denoland.eszip": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "pattern": "^[A-Za-z0-9_-]+$" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string" - }, - "verify_jwt": { - "type": "boolean" - } - }, - "required": ["slug", "name", "body"] - } - } - } - }, + "description": "This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.", + "operationId": "v1-create-a-function", "parameters": [ { "name": "ref", @@ -11805,6 +12950,38 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/vnd.denoland.eszip": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "slug": { + "type": "string", + "pattern": "^[A-Za-z0-9_-]+$" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "verify_jwt": { + "type": "boolean" + } + }, + "required": ["slug", "name", "body"] + } + } + } + }, "responses": { "201": { "description": "", @@ -11866,6 +13043,9 @@ } } }, + "402": { + "description": "Maximum number of functions reached for Plan" + }, "403": { "description": "" }, @@ -11873,17 +13053,17 @@ "description": "Failed to create project's function" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Create a function", + "tags": ["Edge Functions"] }, "put": { - "operationId": "v1-bulk-update-functions", - "summary": "Bulk update functions", "description": "Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.", + "operationId": "v1-bulk-update-functions", "parameters": [ { "name": "ref", @@ -12020,6 +13200,9 @@ } } }, + "402": { + "description": "Maximum number of functions reached for Plan" + }, "403": { "description": "" }, @@ -12027,19 +13210,19 @@ "description": "Failed to update functions" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Bulk update functions", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/deploy": { "post": { - "operationId": "v1-deploy-a-function", - "summary": "Deploy a function", "description": "A new endpoint to deploy functions. It will create if function does not exist.", + "operationId": "v1-deploy-a-function", "parameters": [ { "name": "ref", @@ -12169,6 +13352,9 @@ } } }, + "402": { + "description": "Maximum number of functions reached for Plan" + }, "403": { "description": "" }, @@ -12176,19 +13362,19 @@ "description": "Failed to deploy function" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Deploy a function", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/{function_slug}": { "get": { - "operationId": "v1-get-a-function", - "summary": "Retrieve a function", "description": "Retrieves a function with the specified slug and project.", + "operationId": "v1-get-a-function", "parameters": [ { "name": "ref", @@ -12260,65 +13446,38 @@ "ezbr_sha256": { "type": "string" } - }, - "required": [ - "id", - "slug", - "name", - "status", - "version", - "created_at", - "updated_at" - ] - } - } - } - }, - "403": { - "description": "" - }, - "500": { - "description": "Failed to retrieve function with given slug" - } - }, - "tags": ["Edge Functions"], - "security": [ - { - "bearer": [] - } - ] - }, - "patch": { - "operationId": "v1-update-a-function", - "summary": "Update a function", - "description": "Updates a function with the specified slug and project.", - "requestBody": { - "required": true, - "content": { - "application/vnd.denoland.eszip": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "body": { - "type": "string" - }, - "verify_jwt": { - "type": "boolean" - } + }, + "required": [ + "id", + "slug", + "name", + "status", + "version", + "created_at", + "updated_at" + ] } } } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to retrieve function with given slug" } }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Retrieve a function", + "tags": ["Edge Functions"] + }, + "patch": { + "description": "Updates a function with the specified slug and project.", + "operationId": "v1-update-a-function", "parameters": [ { "name": "ref", @@ -12402,6 +13561,33 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/vnd.denoland.eszip": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "verify_jwt": { + "type": "boolean" + } + } + } + } + } + }, "responses": { "200": { "description": "", @@ -12470,17 +13656,17 @@ "description": "Failed to update function with given slug" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Update a function", + "tags": ["Edge Functions"] }, "delete": { - "operationId": "v1-delete-a-function", - "summary": "Delete a function", "description": "Deletes a function with the specified slug from the specified project.", + "operationId": "v1-delete-a-function", "parameters": [ { "name": "ref", @@ -12516,19 +13702,19 @@ "description": "Failed to delete function with given slug" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Delete a function", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/functions/{function_slug}/body": { "get": { - "operationId": "v1-get-a-function-body", - "summary": "Retrieve a function body", "description": "Retrieves a function body for the specified slug and project.", + "operationId": "v1-get-a-function-body", "parameters": [ { "name": "ref", @@ -12572,18 +13758,18 @@ "description": "Failed to retrieve function body with given slug" } }, - "tags": ["Edge Functions"], "security": [ { "bearer": [] } - ] + ], + "summary": "Retrieve a function body", + "tags": ["Edge Functions"] } }, "/v1/projects/{ref}/storage/buckets": { "get": { "operationId": "v1-list-all-buckets", - "summary": "Lists all buckets", "parameters": [ { "name": "ref", @@ -12640,18 +13826,18 @@ "description": "Failed to get list of buckets" } }, - "tags": ["Storage"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists all buckets", + "tags": ["Storage"] } }, "/v1/projects/{ref}/config/auth/sso/providers": { "post": { "operationId": "v1-create-a-sso-provider", - "summary": "Creates a new SSO provider", "parameters": [ { "name": "ref", @@ -12732,6 +13918,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["type"] @@ -12807,6 +14002,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -12851,16 +14055,16 @@ "description": "SAML 2.0 support is not enabled for this project" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Creates a new SSO provider", + "tags": ["Auth"] }, "get": { "operationId": "v1-list-all-sso-provider", - "summary": "Lists all SSO providers", "parameters": [ { "name": "ref", @@ -12948,6 +14152,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -12996,18 +14209,18 @@ "description": "SAML 2.0 support is not enabled for this project" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists all SSO providers", + "tags": ["Auth"] } }, "/v1/projects/{ref}/config/auth/sso/providers/{provider_id}": { "get": { "operationId": "v1-get-a-sso-provider", - "summary": "Gets a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -13099,6 +14312,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -13143,16 +14365,16 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets a SSO provider by its UUID", + "tags": ["Auth"] }, "put": { "operationId": "v1-update-a-sso-provider", - "summary": "Updates a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -13237,6 +14459,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } } } @@ -13311,6 +14542,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -13355,16 +14595,16 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Updates a SSO provider by its UUID", + "tags": ["Auth"] }, "delete": { "operationId": "v1-delete-a-sso-provider", - "summary": "Removes a SSO provider by its UUID", "parameters": [ { "name": "ref", @@ -13456,6 +14696,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -13500,18 +14749,18 @@ "description": "Either SAML 2.0 was not enabled for this project, or the provider does not exist" } }, - "tags": ["Auth"], "security": [ { "bearer": [] } - ] + ], + "summary": "Removes a SSO provider by its UUID", + "tags": ["Auth"] } }, "/v1/projects/{ref}/database/backups": { "get": { "operationId": "v1-list-all-backups", - "summary": "Lists all backups", "parameters": [ { "name": "ref", @@ -13599,18 +14848,18 @@ "description": "Failed to get backups" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Lists all backups", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/backups/restore-pitr": { "post": { "operationId": "v1-restore-pitr-backup", - "summary": "Restores a PITR backup for a database", "parameters": [ { "name": "ref", @@ -13651,19 +14900,18 @@ "description": "" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Restores a PITR backup for a database", + "tags": ["Database"] } }, "/v1/projects/{ref}/database/backups/restore-point": { "post": { "operationId": "v1-create-restore-point", - "x-internal": true, - "summary": "Initiates a creation of a restore point for a database", "parameters": [ { "name": "ref", @@ -13715,19 +14963,22 @@ } } } + }, + "403": { + "description": "" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Initiates a creation of a restore point for a database", + "tags": ["Database"], + "x-internal": true }, "get": { "operationId": "v1-get-restore-point", - "x-internal": true, - "summary": "Get restore points for project", "parameters": [ { "name": "ref", @@ -13779,19 +15030,19 @@ "description": "Failed to get requested restore points" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Get restore points for project", + "tags": ["Database"], + "x-internal": true } }, "/v1/projects/{ref}/database/backups/undo": { "post": { "operationId": "v1-undo", - "x-internal": true, - "summary": "Initiates an undo to a given restore point", "parameters": [ { "name": "ref", @@ -13831,18 +15082,19 @@ "description": "" } }, - "tags": ["Database"], "security": [ { "bearer": [] } - ] + ], + "summary": "Initiates an undo to a given restore point", + "tags": ["Database"], + "x-internal": true } }, "/v1/organizations/{slug}/members": { "get": { "operationId": "v1-list-organization-members", - "summary": "List members of an organization", "parameters": [ { "name": "slug", @@ -13891,18 +15143,18 @@ "description": "" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "List members of an organization", + "tags": ["Organizations"] } }, "/v1/organizations/{slug}": { "get": { "operationId": "v1-get-an-organization", - "summary": "Gets information about the organization", "parameters": [ { "name": "slug", @@ -13961,19 +15213,18 @@ "description": "" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets information about the organization", + "tags": ["Organizations"] } }, "/v1/organizations/{slug}/project-claim/{token}": { "get": { "operationId": "v1-get-organization-project-claim", - "x-internal": true, - "summary": "Gets project details for the specified organization and claim token", "parameters": [ { "name": "slug", @@ -14130,17 +15381,17 @@ "description": "" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "Gets project details for the specified organization and claim token", + "tags": ["Organizations"], + "x-internal": true }, "post": { "operationId": "v1-claim-project-for-organization", - "x-internal": true, - "summary": "Claims project for the specified organization", "parameters": [ { "name": "slug", @@ -14169,12 +15420,14 @@ "description": "" } }, - "tags": ["Organizations"], "security": [ { "bearer": [] } - ] + ], + "summary": "Claims project for the specified organization", + "tags": ["Organizations"], + "x-internal": true } } }, @@ -14339,6 +15592,9 @@ "review_requested_at": { "type": "string", "format": "date-time" + }, + "with_data": { + "type": "boolean" } }, "required": [ @@ -14350,7 +15606,8 @@ "persistent", "status", "created_at", - "updated_at" + "updated_at", + "with_data" ] }, "BranchDeleteResponse": { @@ -15159,7 +16416,8 @@ "type": "object", "properties": { "custom_hostname": { - "type": "string" + "type": "string", + "minLength": 1 } }, "required": ["custom_hostname"] @@ -15200,29 +16458,106 @@ }, "required": ["banned_ipv4_addresses"] }, - "RemoveNetworkBanRequest": { + "RemoveNetworkBanRequest": { + "type": "object", + "properties": { + "ipv4_addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of IP addresses to unban." + }, + "requester_ip": { + "default": false, + "type": "boolean", + "description": "Include requester's public IP in the list of addresses to unban." + }, + "identifier": { + "type": "string" + } + }, + "required": ["ipv4_addresses"] + }, + "NetworkRestrictionsResponse": { + "type": "object", + "properties": { + "entitlement": { + "type": "string", + "enum": ["disallowed", "allowed"] + }, + "config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "string" + } + }, + "dbAllowedCidrsV6": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." + }, + "old_config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "string" + } + }, + "dbAllowedCidrsV6": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Populated when a new config has been received, but not registered as successfully applied to a project." + }, + "status": { + "type": "string", + "enum": ["stored", "applied"] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "applied_at": { + "type": "string", + "format": "date-time" + } + }, + "required": ["entitlement", "config", "status"] + }, + "NetworkRestrictionsRequest": { "type": "object", "properties": { - "ipv4_addresses": { + "dbAllowedCidrs": { "type": "array", "items": { "type": "string" } }, - "identifier": { - "type": "string" + "dbAllowedCidrsV6": { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": ["ipv4_addresses"] + } }, - "NetworkRestrictionsResponse": { + "NetworkRestrictionsPatchRequest": { "type": "object", "properties": { - "entitlement": { - "type": "string", - "enum": ["disallowed", "allowed"] - }, - "config": { + "add": { "type": "object", "properties": { "dbAllowedCidrs": { @@ -15237,10 +16572,9 @@ "type": "string" } } - }, - "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." + } }, - "old_config": { + "remove": { "type": "object", "properties": { "dbAllowedCidrs": { @@ -15255,9 +16589,69 @@ "type": "string" } } + } + } + } + }, + "NetworkRestrictionsV2Response": { + "type": "object", + "properties": { + "entitlement": { + "type": "string", + "enum": ["disallowed", "allowed"] + }, + "config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["v4", "v6"] + } + }, + "required": ["address", "type"] + } + } + }, + "description": "At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`." + }, + "old_config": { + "type": "object", + "properties": { + "dbAllowedCidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["v4", "v6"] + } + }, + "required": ["address", "type"] + } + } }, "description": "Populated when a new config has been received, but not registered as successfully applied to a project." }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "applied_at": { + "type": "string", + "format": "date-time" + }, "status": { "type": "string", "enum": ["stored", "applied"] @@ -15265,23 +16659,6 @@ }, "required": ["entitlement", "config", "status"] }, - "NetworkRestrictionsRequest": { - "type": "object", - "properties": { - "dbAllowedCidrs": { - "type": "array", - "items": { - "type": "string" - } - }, - "dbAllowedCidrsV6": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, "PgsodiumConfigResponse": { "type": "object", "properties": { @@ -15464,7 +16841,8 @@ "enum": ["not-used", "custom-domain-used", "active"] }, "custom_domain": { - "type": "string" + "type": "string", + "minLength": 1 } }, "required": ["status"] @@ -15710,7 +17088,16 @@ "properties": { "name": { "type": "string", - "enum": ["auth", "db", "pooler", "realtime", "rest", "storage"] + "enum": [ + "auth", + "db", + "db_postgres_user", + "pooler", + "realtime", + "rest", + "storage", + "pg_bouncer" + ] }, "healthy": { "type": "boolean" @@ -15998,9 +17385,31 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "capabilities": { + "type": "object", + "properties": { + "list_v2": { + "type": "boolean" + }, + "iceberg_catalog": { + "type": "boolean" + } + }, + "required": ["list_v2", "iceberg_catalog"] + }, + "external": { + "type": "object", + "properties": { + "upstreamTarget": { + "type": "string", + "enum": ["main", "canary"] + } + }, + "required": ["upstreamTarget"] } }, - "required": ["fileSizeLimit", "features"] + "required": ["fileSizeLimit", "features", "capabilities", "external"] }, "UpdateStorageConfigBody": { "type": "object", @@ -16043,8 +17452,19 @@ } }, "required": ["imageTransformation", "s3Protocol"] + }, + "external": { + "type": "object", + "properties": { + "upstreamTarget": { + "type": "string", + "enum": ["main", "canary"] + } + }, + "required": ["upstreamTarget"] } - } + }, + "additionalProperties": false }, "PostgresConfigResponse": { "type": "object", @@ -16221,7 +17641,8 @@ "restart_database": { "type": "boolean" } - } + }, + "additionalProperties": false }, "V1PgbouncerConfigResponse": { "type": "object", @@ -16632,6 +18053,10 @@ "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { + "type": "boolean", + "nullable": true + }, "external_zoom_client_id": { "type": "string", "nullable": true @@ -16826,6 +18251,14 @@ "type": "integer", "nullable": true }, + "nimbus_oauth_client_id": { + "type": "string", + "nullable": true + }, + "nimbus_oauth_client_secret": { + "type": "string", + "nullable": true + }, "password_hibp_enabled": { "type": "boolean", "nullable": true @@ -17128,6 +18561,7 @@ "external_workos_secret", "external_workos_url", "external_web3_solana_enabled", + "external_web3_ethereum_enabled", "external_zoom_client_id", "external_zoom_enabled", "external_zoom_secret", @@ -17177,6 +18611,8 @@ "mfa_phone_otp_length", "mfa_phone_template", "mfa_phone_max_frequency", + "nimbus_oauth_client_id", + "nimbus_oauth_client_secret", "password_hibp_enabled", "password_min_length", "password_required_characters", @@ -17925,6 +19361,10 @@ "type": "boolean", "nullable": true }, + "external_web3_ethereum_enabled": { + "type": "boolean", + "nullable": true + }, "external_zoom_enabled": { "type": "boolean", "nullable": true @@ -17984,6 +19424,14 @@ "mfa_phone_template": { "type": "string", "nullable": true + }, + "nimbus_oauth_client_id": { + "type": "string", + "nullable": true + }, + "nimbus_oauth_client_secret": { + "type": "string", + "nullable": true } } }, @@ -18418,7 +19866,8 @@ "auth_insufficient_mfa_options", "auth_password_policy_missing", "leaked_service_key", - "no_backup_admin" + "no_backup_admin", + "vulnerable_postgres_version" ] }, "title": { @@ -18492,15 +19941,160 @@ ] } } - }, - "required": ["lints"] + }, + "required": ["lints"] + }, + "AnalyticsResponse": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": {} + }, + "error": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "location": { + "type": "string" + }, + "locationType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "required": ["domain", "location", "locationType", "message", "reason"] + } + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": ["code", "errors", "message", "status"] + } + ] + } + } + }, + "V1GetUsageApiCountResponse": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "total_auth_requests": { + "type": "number" + }, + "total_realtime_requests": { + "type": "number" + }, + "total_rest_requests": { + "type": "number" + }, + "total_storage_requests": { + "type": "number" + } + }, + "required": [ + "timestamp", + "total_auth_requests", + "total_realtime_requests", + "total_rest_requests", + "total_storage_requests" + ] + } + }, + "error": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "code": { + "type": "number" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "domain": { + "type": "string" + }, + "location": { + "type": "string" + }, + "locationType": { + "type": "string" + }, + "message": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "required": ["domain", "location", "locationType", "message", "reason"] + } + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": ["code", "errors", "message", "status"] + } + ] + } + } }, - "AnalyticsResponse": { + "V1GetUsageApiRequestsCountResponse": { "type": "object", "properties": { "result": { "type": "array", - "items": {} + "items": { + "type": "object", + "properties": { + "count": { + "type": "number" + } + }, + "required": ["count"] + } }, "error": { "oneOf": [ @@ -18550,6 +20144,44 @@ } } }, + "CreateRoleBody": { + "type": "object", + "properties": { + "read_only": { + "type": "boolean" + } + }, + "required": ["read_only"] + }, + "CreateRoleResponse": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "password": { + "type": "string", + "minLength": 1 + }, + "ttl_seconds": { + "type": "integer", + "minimum": 1, + "format": "int64" + } + }, + "required": ["role", "password", "ttl_seconds"] + }, + "DeleteRolesResponse": { + "type": "object", + "properties": { + "message": { + "type": "string", + "enum": ["ok"] + } + }, + "required": ["message"] + }, "V1ListMigrationsResponse": { "type": "array", "items": { @@ -18637,6 +20269,247 @@ }, "required": ["databases"] }, + "JitAccessResponse": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + }, + "AuthorizeJitAccessBody": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "rhost": { + "type": "string", + "minLength": 1 + } + }, + "required": ["role", "rhost"] + }, + "JitAuthorizeAccessResponse": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_role": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + }, + "required": ["user_id", "user_role"] + }, + "JitListAccessResponse": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid" + }, + "user_roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "user_roles"] + } + } + }, + "required": ["items"] + }, + "UpdateJitAccessBody": { + "type": "object", + "properties": { + "user_id": { + "type": "string", + "format": "uuid", + "minLength": 1 + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "minLength": 1 + }, + "expires_at": { + "type": "number" + }, + "allowed_networks": { + "type": "object", + "properties": { + "allowed_cidrs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + }, + "allowed_cidrs_v6": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cidr": { + "type": "string" + } + }, + "required": ["cidr"] + } + } + } + } + }, + "required": ["role"] + } + } + }, + "required": ["user_id", "roles"] + }, "FunctionResponse": { "type": "object", "properties": { @@ -19031,6 +20904,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["type"] @@ -19098,6 +20980,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -19200,6 +21091,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -19301,6 +21201,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -19392,6 +21301,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } } }, @@ -19458,6 +21376,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] @@ -19555,6 +21482,15 @@ } }, "required": ["keys"] + }, + "name_id_format": { + "type": "string", + "enum": [ + "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:nameid-format:transient", + "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", + "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" + ] } }, "required": ["id", "entity_id"] diff --git a/apps/studio/components/interfaces/BranchManagement/CreateBranchModal.tsx b/apps/studio/components/interfaces/BranchManagement/CreateBranchModal.tsx index e6c183d0bf073..6ca4120b6c9fc 100644 --- a/apps/studio/components/interfaces/BranchManagement/CreateBranchModal.tsx +++ b/apps/studio/components/interfaces/BranchManagement/CreateBranchModal.tsx @@ -83,7 +83,6 @@ export const CreateBranchModal = () => { const isBranch = projectDetails?.parent_project_ref !== undefined const projectRef = projectDetails !== undefined ? (isBranch ? projectDetails.parent_project_ref : ref) : undefined - const noPhysicalBackups = !projectDetails?.is_physical_backups_enabled const formId = 'create-branch-form' const FormSchema = z @@ -384,7 +383,7 @@ export const CreateBranchModal = () => { label={ <> - {noPhysicalBackups && ( + {!hasPitrEnabled && ( Requires PITR @@ -397,7 +396,7 @@ export const CreateBranchModal = () => { > diff --git a/apps/studio/components/interfaces/Home/Home.constants.ts b/apps/studio/components/interfaces/Home/Home.constants.ts index 46181f40fdcc9..3c8e67b35d243 100644 --- a/apps/studio/components/interfaces/Home/Home.constants.ts +++ b/apps/studio/components/interfaces/Home/Home.constants.ts @@ -1,49 +1,3 @@ -export const CLIENT_LIBRARIES = [ - { - language: 'JavaScript', - officialSupport: true, - releaseState: undefined, - docsUrl: 'https://supabase.com/docs/reference/javascript/installing', - gitUrl: 'https://github.com/supabase/supabase-js', - }, - { - language: 'Flutter', - officialSupport: true, - releaseState: undefined, - docsUrl: 'https://supabase.com/docs/reference/dart/installing', - gitUrl: 'https://github.com/supabase/supabase-flutter', - }, - { - language: 'Python', - officialSupport: true, - releaseState: 'Alpha', - docsUrl: 'https://supabase.com/docs/reference/python/initializing', - gitUrl: 'https://github.com/supabase/supabase-py', - }, - { - language: 'C#', - officialSupport: false, - releaseState: undefined, - docsUrl: 'https://supabase.com/docs/reference/csharp/installing', - gitUrl: 'https://github.com/supabase-community/supabase-csharp', - altIconName: 'c-sharp', - }, - { - language: 'Swift', - officialSupport: true, - releaseState: undefined, - docsUrl: 'https://supabase.com/docs/reference/swift/initializing', - gitUrl: 'https://github.com/supabase/supabase-swift', - }, - { - language: 'Kotlin', - officialSupport: false, - releaseState: undefined, - docsUrl: 'https://supabase.com/docs/reference/kotlin/installing', - gitUrl: 'https://github.com/supabase-community/supabase-kt', - }, -] - export const EXAMPLE_PROJECTS = [ { framework: 'Svelte', diff --git a/apps/studio/components/interfaces/Home/Home.tsx b/apps/studio/components/interfaces/Home/Home.tsx index 014d8749a84a5..eb61861c7b54f 100644 --- a/apps/studio/components/interfaces/Home/Home.tsx +++ b/apps/studio/components/interfaces/Home/Home.tsx @@ -1,12 +1,12 @@ import dayjs from 'dayjs' import Link from 'next/link' -import { useEffect, useMemo, useRef } from 'react' +import { useEffect, useRef } from 'react' import { useParams } from 'common' import { ClientLibrary } from 'components/interfaces/Home' import { AdvisorWidget } from 'components/interfaces/Home/AdvisorWidget' import { ExampleProject } from 'components/interfaces/Home/ExampleProject' -import { CLIENT_LIBRARIES, EXAMPLE_PROJECTS } from 'components/interfaces/Home/Home.constants' +import { EXAMPLE_PROJECTS } from 'components/interfaces/Home/Home.constants' import { NewProjectPanel } from 'components/interfaces/Home/NewProjectPanel/NewProjectPanel' import { ProjectUsageSection } from 'components/interfaces/Home/ProjectUsageSection' import { ServiceStatus } from 'components/interfaces/Home/ServiceStatus' @@ -49,24 +49,13 @@ export const Home = () => { const snap = useAppStateSnapshot() const { ref, enableBranching } = useParams() - const { projectHomepageExampleProjects } = useCustomContent(['project_homepage:example_projects']) + const { projectHomepageExampleProjects, projectHomepageClientLibraries: clientLibraries } = + useCustomContent(['project_homepage:example_projects', 'project_homepage:client_libraries']) const { - projectHomepageShowAllClientLibraries: showAllClientLibraries, projectHomepageShowInstanceSize: showInstanceSize, projectHomepageShowExamples: showExamples, - } = useIsFeatureEnabled([ - 'project_homepage:show_all_client_libraries', - 'project_homepage:show_instance_size', - 'project_homepage:show_examples', - ]) - - const clientLibraries = useMemo(() => { - if (showAllClientLibraries) { - return CLIENT_LIBRARIES - } - return CLIENT_LIBRARIES.filter((library) => library.language === 'JavaScript') - }, [showAllClientLibraries]) + } = useIsFeatureEnabled(['project_homepage:show_instance_size', 'project_homepage:show_examples']) const hasShownEnableBranchingModalRef = useRef(false) const isPaused = project?.status === PROJECT_STATUS.INACTIVE @@ -238,8 +227,9 @@ export const Home = () => {

Client libraries

- {clientLibraries.map((library) => ( - + {clientLibraries!.map((library) => ( + // [Alaister]: Looks like the useCustomContent has wonky types. I'll look at a fix later. + ))}
@@ -248,9 +238,10 @@ export const Home = () => {

Example projects

{!!projectHomepageExampleProjects ? (
- {projectHomepageExampleProjects - .sort((a, b) => a.title.localeCompare(b.title)) - .map((project) => ( + {/* [Alaister]: Looks like the useCustomContent has wonky types. I'll look at a fix later. */} + {(projectHomepageExampleProjects as any) + .sort((a: any, b: any) => a.title.localeCompare(b.title)) + .map((project: any) => ( ))}
diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryDetail.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryDetail.tsx index 9f1531829c5eb..768d10a996d25 100644 --- a/apps/studio/components/interfaces/QueryPerformance/QueryDetail.tsx +++ b/apps/studio/components/interfaces/QueryPerformance/QueryDetail.tsx @@ -6,7 +6,7 @@ import { formatSql } from 'lib/formatSql' import { AlertDescription_Shadcn_, AlertTitle_Shadcn_, Alert_Shadcn_, Button, cn } from 'ui' import { QueryPanelContainer, QueryPanelSection } from './QueryPanel' import { - QUERY_PERFORMANCE_REPORTS, + QUERY_PERFORMANCE_COLUMNS, QUERY_PERFORMANCE_REPORT_TYPES, } from './QueryPerformance.constants' @@ -24,14 +24,10 @@ const SqlMonacoBlock = dynamic( } ) -export const QueryDetail = ({ - reportType, - selectedRow, - onClickViewSuggestion, -}: QueryDetailProps) => { +export const QueryDetail = ({ selectedRow, onClickViewSuggestion }: QueryDetailProps) => { // [Joshen] TODO implement this logic once the linter rules are in const isLinterWarning = false - const report = QUERY_PERFORMANCE_REPORTS[reportType] + const report = QUERY_PERFORMANCE_COLUMNS const [query, setQuery] = useState(selectedRow?.['query']) useEffect(() => { diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.constants.ts b/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.constants.ts index 6dc2007951dfb..057583482936b 100644 --- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.constants.ts +++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.constants.ts @@ -2,41 +2,24 @@ export enum QUERY_PERFORMANCE_REPORT_TYPES { MOST_TIME_CONSUMING = 'most_time_consuming', MOST_FREQUENT = 'most_frequent', SLOWEST_EXECUTION = 'slowest_execution', + UNIFIED = 'unified', } export const QUERY_PERFORMANCE_PRESET_MAP = { [QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING]: 'mostTimeConsuming', [QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT]: 'mostFrequentlyInvoked', [QUERY_PERFORMANCE_REPORT_TYPES.SLOWEST_EXECUTION]: 'slowestExecutionTime', + [QUERY_PERFORMANCE_REPORT_TYPES.UNIFIED]: 'unified', } as const -export const QUERY_PERFORMANCE_REPORTS = { - [QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING]: [ - { id: 'query', name: 'Query', description: undefined, minWidth: 500 }, - { id: 'calls', name: 'Calls', description: undefined, minWidth: 100 }, - { id: 'total_time', name: 'Total time', description: 'latency', minWidth: 150 }, - { id: 'prop_total_time', name: 'Time consumed', description: undefined, minWidth: 150 }, - { id: 'mean_time', name: 'Mean time', description: undefined, minWidth: 150 }, - { id: 'rolname', name: 'Role', description: undefined, minWidth: 120 }, - ], - [QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT]: [ - { id: 'query', name: 'Query', description: undefined, minWidth: 500 }, - { id: 'avg_rows', name: 'Avg. Rows', description: undefined, minWidth: 100 }, - { id: 'calls', name: 'Calls', description: undefined, minWidth: 100 }, - { id: 'total_time', name: 'Total time', description: 'latency', minWidth: 150 }, - { id: 'max_time', name: 'Max time', description: undefined, minWidth: 150 }, - { id: 'mean_time', name: 'Mean time', description: undefined, minWidth: 150 }, - { id: 'min_time', name: 'Min time', description: undefined, minWidth: 150 }, - { id: 'rolname', name: 'Role', description: undefined, minWidth: 120 }, - ], - [QUERY_PERFORMANCE_REPORT_TYPES.SLOWEST_EXECUTION]: [ - { id: 'query', name: 'Query', description: undefined, minWidth: 500 }, - { id: 'avg_rows', name: 'Avg. Rows', description: undefined, minWidth: 100 }, - { id: 'calls', name: 'Calls', description: undefined, minWidth: 100 }, - { id: 'total_time', name: 'Total time', description: 'latency', minWidth: 150 }, - { id: 'max_time', name: 'Max time', description: undefined, minWidth: 150 }, - { id: 'mean_time', name: 'Mean time', description: undefined, minWidth: 150 }, - { id: 'min_time', name: 'Min time', description: undefined, minWidth: 150 }, - { id: 'rolname', name: 'Role', description: undefined, minWidth: 120 }, - ], -} as const +export const QUERY_PERFORMANCE_COLUMNS = [ + { id: 'query', name: 'Query', description: undefined, minWidth: 500 }, + { id: 'calls', name: 'Calls', description: undefined, minWidth: 100 }, + { id: 'total_time', name: 'Total time', description: 'latency', minWidth: 150 }, + { id: 'prop_total_time', name: 'Time consumed', description: undefined, minWidth: 150 }, + { id: 'max_time', name: 'Max time', description: undefined, minWidth: 100 }, + { id: 'mean_time', name: 'Mean time', description: undefined, minWidth: 100 }, + { id: 'min_time', name: 'Min time', description: undefined, minWidth: 100 }, + { id: 'avg_rows', name: 'Avg. Rows', description: undefined, minWidth: 100 }, + { id: 'rolname', name: 'Role', description: undefined, minWidth: 120 }, +] as const diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.tsx index a7272f278e32c..9df7a22eda7e1 100644 --- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.tsx +++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformance.tsx @@ -1,7 +1,6 @@ -import { InformationCircleIcon } from '@heroicons/react/16/solid' import { X } from 'lucide-react' -import { parseAsString, useQueryStates } from 'nuqs' -import { useEffect, useMemo, useState } from 'react' +import { parseAsArrayOf, parseAsString, useQueryStates } from 'nuqs' +import { useEffect, useState } from 'react' import { toast } from 'sonner' import { LOCAL_STORAGE_KEYS, useParams } from 'common' @@ -13,23 +12,10 @@ import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage' import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject' import { IS_PLATFORM } from 'lib/constants' import { useDatabaseSelectorStateSnapshot } from 'state/database-selector' -import { - Button, - LoadingLine, - TabsList_Shadcn_, - TabsTrigger_Shadcn_, - Tabs_Shadcn_, - Tooltip, - TooltipContent, - TooltipTrigger, - cn, -} from 'ui' +import { Button, LoadingLine, cn } from 'ui' import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal' -import ShimmeringLoader from 'ui-patterns/ShimmeringLoader' import { Markdown } from '../Markdown' -import { useQueryPerformanceQuery } from '../Reports/Reports.queries' import { PresetHookResult } from '../Reports/Reports.utils' -import { QUERY_PERFORMANCE_REPORT_TYPES } from './QueryPerformance.constants' import { QueryPerformanceFilterBar } from './QueryPerformanceFilterBar' import { QueryPerformanceGrid } from './QueryPerformanceGrid' @@ -46,11 +32,11 @@ export const QueryPerformance = ({ const { data: project } = useSelectedProjectQuery() const state = useDatabaseSelectorStateSnapshot() - const [{ preset }, setSearchParams] = useQueryStates({ + const [{ search: searchQuery, roles }] = useQueryStates({ sort: parseAsString, search: parseAsString, order: parseAsString, - preset: parseAsString.withDefault(QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING), + roles: parseAsArrayOf(parseAsString).withDefault([]), }) const { isLoading, isRefetching } = queryPerformanceQuery @@ -71,133 +57,13 @@ export const QueryPerformance = ({ const { data: databases } = useReadReplicasQuery({ projectRef: ref }) - const { data: mostTimeConsumingQueries, isLoading: isLoadingMTC } = useQueryPerformanceQuery({ - preset: 'mostTimeConsuming', - }) - const { data: mostFrequentlyInvoked, isLoading: isLoadingMFI } = useQueryPerformanceQuery({ - preset: 'mostFrequentlyInvoked', - }) - const { data: slowestExecutionTime, isLoading: isLoadingMMF } = useQueryPerformanceQuery({ - preset: 'slowestExecutionTime', - }) - - const QUERY_PERFORMANCE_TABS = useMemo(() => { - return [ - { - id: QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING, - label: 'Most time consuming', - description: 'Lists queries ordered by their cumulative total execution time.', - isLoading: isLoadingMTC, - max: - (mostTimeConsumingQueries ?? []).length > 0 - ? Math.max(...(mostTimeConsumingQueries ?? []).map((x: any) => x.total_time)).toFixed(2) - : undefined, - }, - { - id: QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT, - label: 'Most frequent', - description: 'Lists queries in order of their execution count', - isLoading: isLoadingMFI, - max: - (mostFrequentlyInvoked ?? []).length > 0 - ? Math.max(...(mostFrequentlyInvoked ?? []).map((x: any) => x.calls)).toFixed(2) - : undefined, - }, - { - id: QUERY_PERFORMANCE_REPORT_TYPES.SLOWEST_EXECUTION, - label: 'Slowest execution', - description: 'Lists queries ordered by their maximum execution time', - isLoading: isLoadingMMF, - max: - (slowestExecutionTime ?? []).length > 0 - ? Math.max(...(slowestExecutionTime ?? []).map((x: any) => x.max_time)).toFixed(2) - : undefined, - }, - ] - }, [ - isLoadingMFI, - isLoadingMMF, - isLoadingMTC, - mostFrequentlyInvoked, - mostTimeConsumingQueries, - slowestExecutionTime, - ]) - useEffect(() => { state.setSelectedDatabaseId(ref) + // eslint-disable-next-line react-hooks/exhaustive-deps }, [ref]) return ( <> - setSearchParams({ preset: value })} - > - - {QUERY_PERFORMANCE_TABS.map((tab) => { - const tabMax = Number(tab.max) - const maxValue = - tab.id !== QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT - ? tabMax > 1000 - ? (tabMax / 1000).toFixed(2) - : tabMax.toFixed(0) - : tabMax.toLocaleString() - - return ( - - {tab.id === preset && ( -
- )} - -
- {tab.label} - - - - - {tab.description} - -
- {tab.isLoading ? ( - - ) : tab.max === undefined ? ( - - No data yet - - ) : ( - - {maxValue} - {tab.id !== QUERY_PERFORMANCE_REPORT_TYPES.MOST_FREQUENT - ? tabMax > 1000 - ? 's' - : 'ms' - : ' calls'} - - )} - - {tab.id === preset && ( -
- )} - - ) - })} - - - setShowResetgPgStatStatements(true)} diff --git a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceGrid.tsx b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceGrid.tsx index db7336f9abb7f..afbe23df0d192 100644 --- a/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceGrid.tsx +++ b/apps/studio/components/interfaces/QueryPerformance/QueryPerformanceGrid.tsx @@ -26,7 +26,7 @@ import { IndexSuggestionIcon } from './IndexSuggestionIcon' import { QueryDetail } from './QueryDetail' import { QueryIndexes } from './QueryIndexes' import { - QUERY_PERFORMANCE_REPORTS, + QUERY_PERFORMANCE_COLUMNS, QUERY_PERFORMANCE_REPORT_TYPES, } from './QueryPerformance.constants' import { useQueryPerformanceSort } from './hooks/useQueryPerformanceSort' @@ -38,15 +38,14 @@ interface QueryPerformanceGridProps { export const QueryPerformanceGrid = ({ queryPerformanceQuery }: QueryPerformanceGridProps) => { const { sort, setSortConfig } = useQueryPerformanceSort() const gridRef = useRef(null) - const { preset, sort: urlSort, order, roles, search } = useParams() + const { sort: urlSort, order, roles, search } = useParams() const { isLoading, data } = queryPerformanceQuery const [view, setView] = useState<'details' | 'suggestion'>('details') const [selectedRow, setSelectedRow] = useState() - const reportType = - (preset as QUERY_PERFORMANCE_REPORT_TYPES) ?? QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING + const reportType = QUERY_PERFORMANCE_REPORT_TYPES.UNIFIED - const columns = QUERY_PERFORMANCE_REPORTS[reportType].map((col) => { + const columns = QUERY_PERFORMANCE_COLUMNS.map((col) => { const nonSortableColumns = ['query'] const result: Column = { @@ -214,7 +213,8 @@ export const QueryPerformanceGrid = ({ queryPerformanceQuery }: QueryPerformance useEffect(() => { setSelectedRow(undefined) - }, [preset, search, roles, urlSort, order]) + // eslint-disable-next-line react-hooks/exhaustive-deps + }, [search, roles, urlSort, order]) const handleKeyDown = useCallback( (event: KeyboardEvent) => { diff --git a/apps/studio/components/interfaces/QueryPerformance/hooks/useIndexInvalidation.ts b/apps/studio/components/interfaces/QueryPerformance/hooks/useIndexInvalidation.ts index edea843039e83..2a94bbb3f1ebe 100644 --- a/apps/studio/components/interfaces/QueryPerformance/hooks/useIndexInvalidation.ts +++ b/apps/studio/components/interfaces/QueryPerformance/hooks/useIndexInvalidation.ts @@ -26,7 +26,7 @@ export function useIndexInvalidation() { sort: parseAsString, search: parseAsString.withDefault(''), order: parseAsString, - preset: parseAsString.withDefault(QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING), + preset: parseAsString.withDefault('unified'), }) const preset = QUERY_PERFORMANCE_PRESET_MAP[urlPreset as QUERY_PERFORMANCE_REPORT_TYPES] diff --git a/apps/studio/components/interfaces/Reports/Reports.constants.ts b/apps/studio/components/interfaces/Reports/Reports.constants.ts index af8866eae5e4e..28e9067953000 100644 --- a/apps/studio/components/interfaces/Reports/Reports.constants.ts +++ b/apps/studio/components/interfaces/Reports/Reports.constants.ts @@ -492,6 +492,53 @@ select sum(heap_blks_hit) / nullif(sum(heap_blks_hit) + sum(heap_blks_read),0) as ratio from pg_statio_user_tables;`, }, + unified: { + queryType: 'db', + sql: (_params, where, orderBy, runIndexAdvisor = false) => ` + -- reports-query-performance-unified + set search_path to public, extensions; + + select + auth.rolname, + statements.query, + statements.calls, + -- -- Postgres 13, 14, 15 + statements.total_exec_time + statements.total_plan_time as total_time, + statements.min_exec_time + statements.min_plan_time as min_time, + statements.max_exec_time + statements.max_plan_time as max_time, + statements.mean_exec_time + statements.mean_plan_time as mean_time, + -- -- Postgres <= 12 + -- total_time, + -- min_time, + -- max_time, + -- mean_time, + statements.rows / statements.calls as avg_rows, + ((statements.total_exec_time + statements.total_plan_time)/sum(statements.total_exec_time + statements.total_plan_time) OVER()) * 100 as prop_total_time${ + runIndexAdvisor + ? `, + case + when (lower(statements.query) like 'select%' or lower(statements.query) like 'with pgrst%') + then ( + select json_build_object( + 'has_suggestion', array_length(index_statements, 1) > 0, + 'startup_cost_before', startup_cost_before, + 'startup_cost_after', startup_cost_after, + 'total_cost_before', total_cost_before, + 'total_cost_after', total_cost_after, + 'index_statements', index_statements + ) + from index_advisor(statements.query) + ) + else null + end as index_advisor_result` + : '' + } + from pg_stat_statements as statements + inner join pg_authid as auth on statements.userid = auth.oid + ${where || ''} + ${orderBy || 'order by statements.total_exec_time + statements.total_plan_time desc'} + limit 20`, + }, }, }, [Presets.DATABASE]: { diff --git a/apps/studio/components/interfaces/Reports/Reports.queries.ts b/apps/studio/components/interfaces/Reports/Reports.queries.ts index 8de1c7bde575b..1ceae34789235 100644 --- a/apps/studio/components/interfaces/Reports/Reports.queries.ts +++ b/apps/studio/components/interfaces/Reports/Reports.queries.ts @@ -17,7 +17,12 @@ export type QueryPerformanceSort = { } export type QueryPerformanceQueryOpts = { - preset: 'mostFrequentlyInvoked' | 'mostTimeConsuming' | 'slowestExecutionTime' | 'queryHitRate' + preset: + | 'mostFrequentlyInvoked' + | 'mostTimeConsuming' + | 'slowestExecutionTime' + | 'queryHitRate' + | 'unified' searchQuery?: string orderBy?: QueryPerformanceSort roles?: string[] diff --git a/apps/studio/components/layouts/ProjectLayout/BuildingState.tsx b/apps/studio/components/layouts/ProjectLayout/BuildingState.tsx index 90f91b167108a..3ac1bd4847dc7 100644 --- a/apps/studio/components/layouts/ProjectLayout/BuildingState.tsx +++ b/apps/studio/components/layouts/ProjectLayout/BuildingState.tsx @@ -1,16 +1,16 @@ import { useQueryClient } from '@tanstack/react-query' import { ArrowRight, Loader2 } from 'lucide-react' import Link from 'next/link' -import { useMemo } from 'react' import { useParams } from 'common' import ClientLibrary from 'components/interfaces/Home/ClientLibrary' import { ExampleProject } from 'components/interfaces/Home/ExampleProject' -import { CLIENT_LIBRARIES, EXAMPLE_PROJECTS } from 'components/interfaces/Home/Home.constants' +import { EXAMPLE_PROJECTS } from 'components/interfaces/Home/Home.constants' import { DisplayApiSettings, DisplayConfigSettings } from 'components/ui/ProjectSettings' import { invalidateProjectDetailsQuery } from 'data/projects/project-detail-query' import { useProjectStatusQuery } from 'data/projects/project-status-query' import { invalidateProjectsQuery } from 'data/projects/projects-query' +import { useCustomContent } from 'hooks/custom-content/useCustomContent' import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled' import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject' import { PROJECT_STATUS } from 'lib/constants' @@ -21,20 +21,11 @@ const BuildingState = () => { const { data: project } = useSelectedProjectQuery() const queryClient = useQueryClient() - const { - projectHomepageShowAllClientLibraries: showAllClientLibraries, - projectHomepageShowExamples: showExamples, - } = useIsFeatureEnabled([ - 'project_homepage:show_all_client_libraries', - 'project_homepage:show_examples', - ]) + const showExamples = useIsFeatureEnabled('project_homepage:show_examples') - const clientLibraries = useMemo(() => { - if (showAllClientLibraries) { - return CLIENT_LIBRARIES - } - return CLIENT_LIBRARIES.filter((library) => library.language === 'JavaScript') - }, [showAllClientLibraries]) + const { projectHomepageClientLibraries: clientLibraries } = useCustomContent([ + 'project_homepage:client_libraries', + ]) useProjectStatusQuery( { projectRef: ref }, @@ -142,7 +133,7 @@ const BuildingState = () => {

Client libraries

- {clientLibraries.map((library) => ( + {clientLibraries!.map((library) => ( ))}
diff --git a/apps/studio/data/api-authorization/api-authorization-query.ts b/apps/studio/data/api-authorization/api-authorization-query.ts index 529302cb95e76..37d0f58356c04 100644 --- a/apps/studio/data/api-authorization/api-authorization-query.ts +++ b/apps/studio/data/api-authorization/api-authorization-query.ts @@ -17,6 +17,7 @@ export type ApiAuthorizationResponse = { expires_at: string approved_at: string | null approved_organization_slug?: string + registration_type: string } export async function getApiAuthorizationDetails( diff --git a/apps/studio/hooks/custom-content/CustomContent.types.ts b/apps/studio/hooks/custom-content/CustomContent.types.ts index eb4729847dd42..7ecf9482ede56 100644 --- a/apps/studio/hooks/custom-content/CustomContent.types.ts +++ b/apps/studio/hooks/custom-content/CustomContent.types.ts @@ -11,6 +11,14 @@ export type CustomContentTypes = { action: { text: string; url: string } }[] + projectHomepageClientLibraries: { + language: string + officialSupport: boolean + releaseState?: string + docsUrl: string + gitUrl: string + altIconName?: string + }[] projectHomepageExampleProjects: { title: string description: string diff --git a/apps/studio/hooks/custom-content/custom-content.json b/apps/studio/hooks/custom-content/custom-content.json index b7e6332bd3dbc..8d3ad6f7b3c6c 100644 --- a/apps/studio/hooks/custom-content/custom-content.json +++ b/apps/studio/hooks/custom-content/custom-content.json @@ -5,6 +5,46 @@ "organization:legal_documents": null, + "project_homepage:client_libraries": [ + { + "language": "JavaScript", + "officialSupport": true, + "docsUrl": "https://supabase.com/docs/reference/javascript/installing", + "gitUrl": "https://github.com/supabase/supabase-js" + }, + { + "language": "Flutter", + "officialSupport": true, + "docsUrl": "https://supabase.com/docs/reference/dart/installing", + "gitUrl": "https://github.com/supabase/supabase-flutter" + }, + { + "language": "Python", + "officialSupport": true, + "releaseState": "Alpha", + "docsUrl": "https://supabase.com/docs/reference/python/initializing", + "gitUrl": "https://github.com/supabase/supabase-py" + }, + { + "language": "C#", + "officialSupport": false, + "docsUrl": "https://supabase.com/docs/reference/csharp/installing", + "gitUrl": "https://github.com/supabase-community/supabase-csharp", + "altIconName": "c-sharp" + }, + { + "language": "Swift", + "officialSupport": true, + "docsUrl": "https://supabase.com/docs/reference/swift/initializing", + "gitUrl": "https://github.com/supabase/supabase-swift" + }, + { + "language": "Kotlin", + "officialSupport": false, + "docsUrl": "https://supabase.com/docs/reference/kotlin/installing", + "gitUrl": "https://github.com/supabase-community/supabase-kt" + } + ], "project_homepage:example_projects": null, "logs:default_query": null, diff --git a/apps/studio/hooks/custom-content/custom-content.sample.json b/apps/studio/hooks/custom-content/custom-content.sample.json index d19b34e4cdc04..3573fc9471aa7 100644 --- a/apps/studio/hooks/custom-content/custom-content.sample.json +++ b/apps/studio/hooks/custom-content/custom-content.sample.json @@ -24,6 +24,14 @@ } ], + "project_homepage:client_libraries": [ + { + "language": "JavaScript", + "officialSupport": true, + "docsUrl": "https://supabase.com/docs/reference/javascript/installing", + "gitUrl": "https://github.com/supabase/supabase-js" + } + ], "project_homepage:example_projects": [ { "title": "Framework 1", diff --git a/apps/studio/hooks/custom-content/custom-content.schema.json b/apps/studio/hooks/custom-content/custom-content.schema.json index b478095fd0ff6..f039fa2b98c25 100644 --- a/apps/studio/hooks/custom-content/custom-content.schema.json +++ b/apps/studio/hooks/custom-content/custom-content.schema.json @@ -31,6 +31,22 @@ } }, + "project_homepage:client_libraries": { + "type": "array", + "description": "Renders a provided set of client libraries under the project's home page", + "items": { + "type": "object", + "properties": { + "language": { "type": "string" }, + "officialSupport": { "type": "boolean" }, + "releaseState": { "type": "string" }, + "docsUrl": { "type": "string" }, + "gitUrl": { "type": "string" }, + "altIconName": { "type": "string" } + }, + "required": ["language", "officialSupport", "docsUrl", "gitUrl"] + } + }, "project_homepage:example_projects": { "type": ["array", "null"], "description": "Renders a provided set of example projects under the project's home page", @@ -95,6 +111,7 @@ }, "required": [ "organization:legal_documents", + "project_homepage:client_libraries", "project_homepage:example_projects", "logs:default_query", "connect:frameworks", diff --git a/apps/studio/pages/authorize.tsx b/apps/studio/pages/authorize.tsx index 9b04c2ea456d7..51ffe39c28523 100644 --- a/apps/studio/pages/authorize.tsx +++ b/apps/studio/pages/authorize.tsx @@ -51,6 +51,7 @@ const APIAuthorizationPage: NextPageWithLayout = () => { const { data: requester, isLoading, isError, error } = useApiAuthorizationQuery({ id: auth_id }) const isApproved = (requester?.approved_at ?? null) !== null const isExpired = dayjs().isAfter(dayjs(requester?.expires_at)) + const isMcpClient = requester?.registration_type === 'dynamic' const searchParams = typeof window !== 'undefined' ? new URLSearchParams(location.search) : new URLSearchParams() @@ -193,6 +194,18 @@ const APIAuthorizationPage: NextPageWithLayout = () => { Authorize API access for {requester?.name} + {isMcpClient && ( + + + MCP Client Connection + + This is an MCP (Model Context Protocol) client designed to connect with AI + applications. Please ensure you trust this application before granting access to your + organization's data. + + + )} + { const { isIndexAdvisorEnabled } = useIndexAdvisorStatus() const { sort: sortConfig } = useQueryPerformanceSort() - const [{ preset: urlPreset, search: searchQuery, roles }] = useQueryStates({ + const [{ search: searchQuery, roles }] = useQueryStates({ sort: parseAsString, order: parseAsString, search: parseAsString.withDefault(''), - preset: parseAsString.withDefault(QUERY_PERFORMANCE_REPORT_TYPES.MOST_TIME_CONSUMING), roles: parseAsArrayOf(parseAsString).withDefault([]), }) @@ -37,12 +36,10 @@ const QueryPerformanceReport: NextPageWithLayout = () => { const hooks = queriesFactory(config.queries, ref ?? 'default') const queryHitRate = hooks.queryHitRate() - const preset = QUERY_PERFORMANCE_PRESET_MAP[urlPreset as QUERY_PERFORMANCE_REPORT_TYPES] - const queryPerformanceQuery = useQueryPerformanceQuery({ searchQuery, orderBy: sortConfig || undefined, - preset, + preset: 'unified', roles, runIndexAdvisor: isIndexAdvisorEnabled, }) diff --git a/apps/ui-library/styles/globals.css b/apps/ui-library/styles/globals.css index 6055914127f57..2a46862296367 100644 --- a/apps/ui-library/styles/globals.css +++ b/apps/ui-library/styles/globals.css @@ -1,12 +1,12 @@ -@tailwind base; -@tailwind components; -@tailwind utilities; - @import './../../../packages/ui/build/css/source/global.css'; @import './../../../packages/ui/build/css/themes/dark.css'; @import './../../../packages/ui/build/css/themes/classic-dark.css'; @import './../../../packages/ui/build/css/themes/light.css'; +@tailwind base; +@tailwind components; +@tailwind utilities; + @layer base { :root { --background: 0 0% 100%; diff --git a/packages/common/enabled-features/enabled-features.json b/packages/common/enabled-features/enabled-features.json index be8eb9c1e7e30..17203725ab879 100644 --- a/packages/common/enabled-features/enabled-features.json +++ b/packages/common/enabled-features/enabled-features.json @@ -53,7 +53,6 @@ "project_creation:show_advanced_config": true, - "project_homepage:show_all_client_libraries": true, "project_homepage:show_instance_size": true, "project_homepage:show_examples": true, diff --git a/packages/common/enabled-features/enabled-features.schema.json b/packages/common/enabled-features/enabled-features.schema.json index 546150fa8eb7d..78fe597adf5b4 100644 --- a/packages/common/enabled-features/enabled-features.schema.json +++ b/packages/common/enabled-features/enabled-features.schema.json @@ -183,10 +183,6 @@ "type": "boolean", "description": "Show the example projects in the project homepage" }, - "project_homepage:show_all_client_libraries": { - "type": "boolean", - "description": "Show all client libraries examples in the project homepage. When false, all client library examples will be hidden except the JavaScript client library." - }, "project_addons:dedicated_ipv4_address": { "type": "boolean", @@ -276,7 +272,6 @@ "project_creation:show_advanced_config", "project_homepage:show_instance_size", "project_homepage:show_examples", - "project_homepage:show_all_client_libraries", "project_addons:dedicated_ipv4_address", "project_settings:custom_domains", "project_settings:show_disable_legacy_api_keys",