dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 09:25:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update js sdk docs (2.107.0) (#46583)

Browse Source 
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.107.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
This commit is contained in:
supabase-supabase-autofixer[bot]andsupabase-releaser[bot] authored and GitHub committed 2026-06-02 16:45:59 +02:00
1 parent 99f4b4230a
commit af24c397fd
16 files changed
+55958 -45970
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap
+311 -49
View File
@@ -762,6 +762,83 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
}
},
"@supabase/supabase-js.AuthRefreshDiscardedError.constructor": {
"name": "@supabase/supabase-js.AuthRefreshDiscardedError.constructor",
"params": [
{
"name": "message",
"type": {
"type": "intrinsic",
"name": "string"
},
"isOptional": true
}
],
"ret": {
"type": {
"type": "nameOnly",
"name": "AuthRefreshDiscardedError"
}
}
},
"@supabase/supabase-js.AuthRefreshDiscardedError.toJSON": {
"name": "@supabase/supabase-js.AuthRefreshDiscardedError.toJSON",
"params": [],
"ret": {
"type": {
"type": "object",
"properties": [
{
"name": "code",
"type": {
"type": "union",
"subTypes": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "nameOnly",
"name": "ErrorCode"
},
null
]
}
},
{
"name": "message",
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"name": "name",
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"name": "status",
"type": {
"type": "union",
"subTypes": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
]
}
}
},
"@supabase/supabase-js.AuthRetryableFetchError.constructor": {
"name": "@supabase/supabase-js.AuthRetryableFetchError.constructor",
"params": [
@@ -10435,13 +10512,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"isOptional": true,
"comment": {
"shortText": "Provide your own locking mechanism based on the environment. By default,\\n\`navigatorLock\` (Web Locks API) is used in browser environments when\\n\`persistSession\` is true. Falls back to an in-process lock for non-browser\\nenvironments (e.g. React Native).",
"tags": [
{
"tag": "experimental",
"text": ""
}
]
"shortText": "Provide your own locking mechanism based on the environment. By default\\nthe client coordinates refreshes itself (single-flight via\\n\`refreshingDeferred\` + commit guard) and relies on the GoTrue server to\\nresolve cross-tab refresh races. Passing a custom lock opts into a\\nlegacy path that wraps every auth operation in your supplied lock — this\\npath is preserved for backwards compatibility (typically React Native\\n\`processLock\` or Node multi-process setups)."
}
},
{
@@ -10452,14 +10523,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"isOptional": true,
"comment": {
"shortText": "The maximum time in milliseconds to wait for acquiring a cross-tab synchronization lock.\\n\\nWhen multiple browser tabs or windows use the auth client simultaneously, they coordinate\\nvia the Web Locks API to prevent race conditions during session refresh and other operations.\\nThis timeout controls how long to wait before attempting lock recovery.\\n\\n- **Positive value**: Wait up to this many milliseconds. If the lock is still held, attempt\\n automatic recovery by stealing it (the previous holder is evicted, its callback continues\\n to completion without exclusive access). This recovers from orphaned locks caused by\\n React Strict Mode double-mount, storage API hangs, or aborted operations.\\n- **Zero (0)**: Fail immediately if the lock is unavailable; throws \`LockAcquireTimeoutError\`\\n (check \`error.isAcquireTimeout === true\`).\\n- **Negative value**: Wait indefinitely — can cause permanent deadlocks if the lock is orphaned.",
"examples": [
{
"id": "example-1",
"name": "Example 1",
"code": "\`\`\`ts\\nconst client = createClient(url, key, {\\n auth: {\\n lockAcquireTimeout: 5000, // 5 seconds, then steal orphaned lock\\n },\\n})\\n\`\`\`"
}
]
"shortText": "The maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via the \`lock\` option. Only consulted when a custom \`lock\` is\\npassed — the default lockless path doesn't use this timeout."
}
},
{
@@ -20195,6 +20259,30 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
}
},
"@supabase/supabase-js.GoTrueClient.dispose": {
"name": "@supabase/supabase-js.GoTrueClient.dispose",
"params": [],
"ret": {
"type": {
"type": "promise",
"name": "Promise",
"awaited": {
"type": "intrinsic",
"name": "void"
}
}
},
"comment": {
"shortText": "Tears down the client's background work: stops the auto-refresh interval,\\nremoves the \`visibilitychange\` listener, closes the cross-tab\\n\`BroadcastChannel\`, and clears registered \`onAuthStateChange\` subscribers.\\n\\nCall this from cleanup hooks when the client is being replaced before\\nits JS realm is destroyed. React Strict Mode and HMR are the common\\ncases. Any in-flight \`fetch\` calls continue to completion and may still\\nwrite to storage; dispose doesn't abort them or erase storage.\\n\\nLifecycle caveat: because in-flight refreshes are not aborted, a\\ndisposed instance can still persist a rotated session to storage after\\n\`dispose()\` returns. A subsequent \`createClient\` against the same\\n\`storageKey\` will pick up that session on its next read. If you need\\nstrict isolation between client lifecycles, await any pending auth\\noperation before calling \`dispose()\` (or change the \`storageKey\` for\\nthe replacement client).\\n\\nSafe to call repeatedly.",
"examples": [
{
"id": "cleanup-on-react-unmount",
"name": "Cleanup on React unmount",
"code": "\`\`\`ts\\nuseEffect(() => {\\n const client = createClient(...)\\n return () => { client.auth.dispose() }\\n}, [])\\n\`\`\`"
}
]
}
},
"@supabase/supabase-js.GoTrueClient.exchangeCodeForSession": {
"name": "@supabase/supabase-js.GoTrueClient.exchangeCodeForSession",
"params": [
@@ -22633,7 +22721,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"comment": {
"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.",
"text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- When using in a browser, this function is synchronized across all tabs using the [LockManager](https://developer.mozilla.org/en-US/docs/Web/API/LockManager) API. In other environments make sure you've defined a proper \`lock\` property, if necessary, to make sure there are no race conditions while the session is being refreshed.",
"text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed.",
"examples": [
{
"id": "get-the-session-data",
@@ -27982,7 +28070,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Avoid using an async function inside \`onAuthStateChange\` as you might end\\nup with a deadlock. The callback function runs inside an exclusive lock,\\nso calling other Supabase Client APIs that also try to acquire the\\nexclusive lock, might cause a deadlock. This behavior is observable across\\ntabs. In the next major library version, this behavior will not be supported.\\n\\nReceive a notification every time an auth event happens."
"shortText": "Receive a notification every time an auth event happens. Common reentry\\npatterns (\`getUser\`, \`setSession\`, reading the session from inside a\\nhandler) complete normally. One hazard remains: calling \`refreshSession\`\\n(or anything that routes through \`_callRefreshToken\`) from inside a\\n\`TOKEN_REFRESHED\` handler. \`refreshingDeferred\` resolves only after\\n\`_notifyAllSubscribers\` returns, so the inner refresh dedupes onto the\\nouter's unresolved promise and the two wait on each other."
}
}
]
@@ -37909,6 +37997,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
"id": "sign-in-with-phone-and-password",
"name": "Sign in with phone and password",
"code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n phone: '+13334445555',\\n password: 'some-password',\\n})\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\nif (error) {\\n console.error(error)\\n return\\n}\\n\`\`\`",
"description": "Log the full \`error\` object so fields like \`code\`, \`status\`, and \`name\` aren't hidden. The \`error.code\` (e.g. \`'invalid_credentials'\`, \`'email_not_confirmed'\`) is often more useful for branching than \`error.message\`, and the full object surfaces both."
}
]
}
@@ -47228,6 +47322,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "delete-a-record-and-return-it",
"name": "Delete a record and return it",
@@ -47341,6 +47441,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "create-a-record-and-return-it",
"name": "Create a record and return it",
@@ -47445,6 +47551,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.from('characters').select()\\nif (error) {\\n // Logs the full error: message, code, details, and hint.\\n console.error(error)\\n return\\n}\\n\`\`\`",
"description": "The most useful field on a Postgres error is usually \`hint\` — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (\`code: '42501'\`) arrives with a \`hint\` like \`\\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\"\`. Log the full \`error\` object so the hint isn't hidden behind \`error.message\`.",
"response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"42501\\",\\n \\"details\\": null,\\n \\"hint\\": \\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\",\\n \\"message\\": \\"permission denied for table characters\\"\\n },\\n \\"status\\": 401,\\n \\"statusText\\": \\"Unauthorized\\"\\n}\\n\`\`\`"
},
{
"id": "selecting-specific-columns",
"name": "Selecting specific columns",
@@ -47626,6 +47739,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "update-a-record-and-return-it",
"name": "Update a record and return it",
@@ -47773,6 +47892,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "bulk-upsert-your-data",
"name": "Bulk Upsert your data",
@@ -50060,7 +50185,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback."
"shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\\n\\nPayloads that are \`ArrayBuffer\` or \`ArrayBufferView\` (e.g. \`Uint8Array\`) are sent as\\n\`application/octet-stream\`; all other payloads are JSON-encoded."
}
},
"@supabase/supabase-js.RealtimeChannel.on": {
@@ -51688,7 +51813,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Subscribe registers your client with the server"
"shortText": "Subscribe registers your client with the server.\\n\\nThe optional \`callback\` receives a \`status\` and, on failure, an \`err\` argument.\\nLog the full \`err\` so its \`cause\`, \`name\`, and any structured fields aren't hidden\\nbehind \`err.message\`.",
"examples": [
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nsupabase.channel('room1').subscribe((status, err) => {\\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\\n // Log the full error: its \`cause\` often holds the underlying reason.\\n console.error(status, err)\\n }\\n})\\n\`\`\`"
}
]
}
},
"@supabase/supabase-js.RealtimeChannel.teardown": {
@@ -52158,13 +52290,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"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": ""
}
]
"shortText": "Provide your own locking mechanism based on the environment. By default\\nthe auth client coordinates refreshes itself and the server resolves\\ncross-tab races. Passing a custom \`lock\` opts into a legacy path that\\nwraps every auth operation in your supplied lock."
}
},
{
@@ -52175,7 +52301,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"isOptional": true,
"comment": {
"shortText": "Maximum time in milliseconds to wait when acquiring the auth lock before\\nstealing it from the previous holder. See \`GoTrueClientOptions.lockAcquireTimeout\`\\nfor full semantics (zero fails immediately, negative waits indefinitely)."
"shortText": "Maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via \`lock\`. Only consulted when a custom \`lock\` is passed."
}
},
{
@@ -54417,6 +54543,82 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
}
},
"@supabase/auth-js.AuthRefreshDiscardedError.constructor": {
"name": "@supabase/auth-js.AuthRefreshDiscardedError.constructor",
"params": [
{
"name": "message",
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"ret": {
"type": {
"type": "nameOnly",
"name": "AuthRefreshDiscardedError"
}
}
},
"@supabase/auth-js.AuthRefreshDiscardedError.toJSON": {
"name": "@supabase/auth-js.AuthRefreshDiscardedError.toJSON",
"params": [],
"ret": {
"type": {
"type": "object",
"properties": [
{
"name": "code",
"type": {
"type": "union",
"subTypes": [
{
"type": "intrinsic",
"name": "undefined"
},
null,
{
"type": "nameOnly",
"name": "ErrorCode"
}
]
}
},
{
"name": "message",
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"name": "name",
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"name": "status",
"type": {
"type": "union",
"subTypes": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
]
}
}
},
"@supabase/auth-js.AuthRetryableFetchError.constructor": {
"name": "@supabase/auth-js.AuthRetryableFetchError.constructor",
"params": [
@@ -63871,13 +64073,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"isOptional": true,
"comment": {
"shortText": "Provide your own locking mechanism based on the environment. By default,\\n\`navigatorLock\` (Web Locks API) is used in browser environments when\\n\`persistSession\` is true. Falls back to an in-process lock for non-browser\\nenvironments (e.g. React Native).",
"tags": [
{
"tag": "experimental",
"text": ""
}
]
"shortText": "Provide your own locking mechanism based on the environment. By default\\nthe client coordinates refreshes itself (single-flight via\\n\`refreshingDeferred\` + commit guard) and relies on the GoTrue server to\\nresolve cross-tab refresh races. Passing a custom lock opts into a\\nlegacy path that wraps every auth operation in your supplied lock — this\\npath is preserved for backwards compatibility (typically React Native\\n\`processLock\` or Node multi-process setups)."
}
},
{
@@ -63888,14 +64084,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"isOptional": true,
"comment": {
"shortText": "The maximum time in milliseconds to wait for acquiring a cross-tab synchronization lock.\\n\\nWhen multiple browser tabs or windows use the auth client simultaneously, they coordinate\\nvia the Web Locks API to prevent race conditions during session refresh and other operations.\\nThis timeout controls how long to wait before attempting lock recovery.\\n\\n- **Positive value**: Wait up to this many milliseconds. If the lock is still held, attempt\\n automatic recovery by stealing it (the previous holder is evicted, its callback continues\\n to completion without exclusive access). This recovers from orphaned locks caused by\\n React Strict Mode double-mount, storage API hangs, or aborted operations.\\n- **Zero (0)**: Fail immediately if the lock is unavailable; throws \`LockAcquireTimeoutError\`\\n (check \`error.isAcquireTimeout === true\`).\\n- **Negative value**: Wait indefinitely — can cause permanent deadlocks if the lock is orphaned.",
"examples": [
{
"id": "example-1",
"name": "Example 1",
"code": "\`\`\`ts\\nconst client = createClient(url, key, {\\n auth: {\\n lockAcquireTimeout: 5000, // 5 seconds, then steal orphaned lock\\n },\\n})\\n\`\`\`"
}
]
"shortText": "The maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via the \`lock\` option. Only consulted when a custom \`lock\` is\\npassed — the default lockless path doesn't use this timeout."
}
},
{
@@ -70464,6 +70653,30 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
"shortText": "Verifies a passkey registration credential against a previously issued\\nchallenge. Used as the second step of a two-step registration flow."
}
},
"@supabase/auth-js.GoTrueClient.dispose": {
"name": "@supabase/auth-js.GoTrueClient.dispose",
"params": [],
"ret": {
"type": {
"type": "promise",
"name": "Promise",
"awaited": {
"type": "intrinsic",
"name": "void"
}
}
},
"comment": {
"shortText": "Tears down the client's background work: stops the auto-refresh interval,\\nremoves the \`visibilitychange\` listener, closes the cross-tab\\n\`BroadcastChannel\`, and clears registered \`onAuthStateChange\` subscribers.\\n\\nCall this from cleanup hooks when the client is being replaced before\\nits JS realm is destroyed. React Strict Mode and HMR are the common\\ncases. Any in-flight \`fetch\` calls continue to completion and may still\\nwrite to storage; dispose doesn't abort them or erase storage.\\n\\nLifecycle caveat: because in-flight refreshes are not aborted, a\\ndisposed instance can still persist a rotated session to storage after\\n\`dispose()\` returns. A subsequent \`createClient\` against the same\\n\`storageKey\` will pick up that session on its next read. If you need\\nstrict isolation between client lifecycles, await any pending auth\\noperation before calling \`dispose()\` (or change the \`storageKey\` for\\nthe replacement client).\\n\\nSafe to call repeatedly.",
"examples": [
{
"id": "cleanup-on-react-unmount",
"name": "Cleanup on React unmount",
"code": "\`\`\`ts\\nuseEffect(() => {\\n const client = createClient(...)\\n return () => { client.auth.dispose() }\\n}, [])\\n\`\`\`"
}
]
}
},
"@supabase/auth-js.GoTrueClient.exchangeCodeForSession": {
"name": "@supabase/auth-js.GoTrueClient.exchangeCodeForSession",
"params": [
@@ -72901,7 +73114,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"comment": {
"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.",
"text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- When using in a browser, this function is synchronized across all tabs using the [LockManager](https://developer.mozilla.org/en-US/docs/Web/API/LockManager) API. In other environments make sure you've defined a proper \`lock\` property, if necessary, to make sure there are no race conditions while the session is being refreshed.",
"text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed.",
"examples": [
{
"id": "get-the-session-data",
@@ -76850,7 +77063,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"comment": {
"shortText": "Receive a notification every time an auth event happens.\\nSafe to use without an async function as callback.",
"text": "- Subscribes to important events occurring on the user's session.\\n- Use on the frontend/client. It is less useful on the server.\\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\\n- **Important:** A callback can be an \`async\` function and it runs synchronously during the processing of the changes causing the event. You can easily create a dead-lock by using \`await\` on a call to another method of the Supabase library.\\n - Avoid using \`async\` functions as callbacks.\\n - Limit the number of \`await\` calls in \`async\` callbacks.\\n - Do not use other Supabase functions in the callback function. If you must, dispatch the functions once the callback has finished executing. Use this as a quick way to achieve this:\\n \`\`\`js\\n supabase.auth.onAuthStateChange((event, session) => {\\n setTimeout(async () => {\\n // await on other Supabase function here\\n // this runs right after the callback has finished\\n }, 0)\\n })\\n \`\`\`\\n- Emitted events:\\n - \`INITIAL_SESSION\`\\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\\n - \`SIGNED_IN\`\\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\\n - This event can fire very frequently depending on the number of tabs open in your application.\\n - \`SIGNED_OUT\`\\n - Emitted when the user signs out. This can be after:\\n - A call to \`supabase.auth.signOut()\`.\\n - After the user's session has expired for any reason:\\n - User has signed out on another device.\\n - The session has reached its timebox limit or inactivity timeout.\\n - User has signed in on another device with single session per user enabled.\\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\\n - Use this to clean up any local storage your application has associated with the user.\\n - \`TOKEN_REFRESHED\`\\n - Emitted each time a new access and refresh token are fetched for the signed in user.\\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\\n - Avoid frequent calls to \`supabase.auth.getSession()\` for the same purpose.\\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\\n - The frequency of this event is related to the JWT expiry limit configured on your project.\\n - \`USER_UPDATED\`\\n - Emitted each time the \`supabase.auth.updateUser()\` method finishes successfully. Listen to it to update your application's UI based on new profile information.\\n - \`PASSWORD_RECOVERY\`\\n - Emitted instead of the \`SIGNED_IN\` event when the user lands on a page that includes a password recovery link in the URL.\\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password).",
"text": "- Subscribes to important events occurring on the user's session.\\n- Use on the frontend/client. It is less useful on the server.\\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\\n- Callbacks can be \`async\` and can safely call other Supabase auth methods (\`getUser\`, \`setSession\`, etc.) from inside the callback.\\n- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab.\\n- Emitted events:\\n - \`INITIAL_SESSION\`\\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\\n - \`SIGNED_IN\`\\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\\n - This event can fire very frequently depending on the number of tabs open in your application.\\n - \`SIGNED_OUT\`\\n - Emitted when the user signs out. This can be after:\\n - A call to \`supabase.auth.signOut()\`.\\n - After the user's session has expired for any reason:\\n - User has signed out on another device.\\n - The session has reached its timebox limit or inactivity timeout.\\n - User has signed in on another device with single session per user enabled.\\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\\n - Use this to clean up any local storage your application has associated with the user.\\n - \`TOKEN_REFRESHED\`\\n - Emitted each time a new access and refresh token are fetched for the signed in user.\\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\\n - Avoid frequent calls to \`supabase.auth.getSession()\` for the same purpose.\\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\\n - The frequency of this event is related to the JWT expiry limit configured on your project.\\n - \`USER_UPDATED\`\\n - Emitted each time the \`supabase.auth.updateUser()\` method finishes successfully. Listen to it to update your application's UI based on new profile information.\\n - \`PASSWORD_RECOVERY\`\\n - Emitted instead of the \`SIGNED_IN\` event when the user lands on a page that includes a password recovery link in the URL.\\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password).",
"examples": [
{
"id": "listen-to-auth-changes",
@@ -78305,7 +78518,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Avoid using an async function inside \`onAuthStateChange\` as you might end\\nup with a deadlock. The callback function runs inside an exclusive lock,\\nso calling other Supabase Client APIs that also try to acquire the\\nexclusive lock, might cause a deadlock. This behavior is observable across\\ntabs. In the next major library version, this behavior will not be supported.\\n\\nReceive a notification every time an auth event happens."
"shortText": "Receive a notification every time an auth event happens. Common reentry\\npatterns (\`getUser\`, \`setSession\`, reading the session from inside a\\nhandler) complete normally. One hazard remains: calling \`refreshSession\`\\n(or anything that routes through \`_callRefreshToken\`) from inside a\\n\`TOKEN_REFRESHED\` handler. \`refreshingDeferred\` resolves only after\\n\`_notifyAllSubscribers\` returns, so the inner refresh dedupes onto the\\nouter's unresolved promise and the two wait on each other."
}
}
]
@@ -88231,6 +88444,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
"id": "sign-in-with-phone-and-password",
"name": "Sign in with phone and password",
"code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n phone: '+13334445555',\\n password: 'some-password',\\n})\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\nif (error) {\\n console.error(error)\\n return\\n}\\n\`\`\`",
"description": "Log the full \`error\` object so fields like \`code\`, \`status\`, and \`name\` aren't hidden. The \`error.code\` (e.g. \`'invalid_credentials'\`, \`'email_not_confirmed'\`) is often more useful for branching than \`error.message\`, and the full object surfaces both."
}
]
}
@@ -98411,6 +98630,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "delete-a-record-and-return-it",
"name": "Delete a record and return it",
@@ -98523,6 +98748,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "create-a-record-and-return-it",
"name": "Create a record and return it",
@@ -98627,6 +98858,13 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.from('characters').select()\\nif (error) {\\n // Logs the full error: message, code, details, and hint.\\n console.error(error)\\n return\\n}\\n\`\`\`",
"description": "The most useful field on a Postgres error is usually \`hint\` — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (\`code: '42501'\`) arrives with a \`hint\` like \`\\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\"\`. Log the full \`error\` object so the hint isn't hidden behind \`error.message\`.",
"response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"42501\\",\\n \\"details\\": null,\\n \\"hint\\": \\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\",\\n \\"message\\": \\"permission denied for table characters\\"\\n },\\n \\"status\\": 401,\\n \\"statusText\\": \\"Unauthorized\\"\\n}\\n\`\`\`"
},
{
"id": "selecting-specific-columns",
"name": "Selecting specific columns",
@@ -98807,6 +99045,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "update-a-record-and-return-it",
"name": "Update a record and return it",
@@ -98953,6 +99197,12 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
},
"response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\\nif (error) console.error(error)\\n\`\`\`",
"description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`."
},
{
"id": "bulk-upsert-your-data",
"name": "Bulk Upsert your data",
@@ -101362,7 +101612,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback."
"shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\\n\\nPayloads that are \`ArrayBuffer\` or \`ArrayBufferView\` (e.g. \`Uint8Array\`) are sent as\\n\`application/octet-stream\`; all other payloads are JSON-encoded."
}
},
"@supabase/realtime-js.RealtimeChannel.on": {
@@ -103050,7 +103300,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
"comment": {
"shortText": "Subscribe registers your client with the server"
"shortText": "Subscribe registers your client with the server.\\n\\nThe optional \`callback\` receives a \`status\` and, on failure, an \`err\` argument.\\nLog the full \`err\` so its \`cause\`, \`name\`, and any structured fields aren't hidden\\nbehind \`err.message\`.",
"examples": [
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nsupabase.channel('room1').subscribe((status, err) => {\\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\\n // Log the full error: its \`cause\` often holds the underlying reason.\\n console.error(status, err)\\n }\\n})\\n\`\`\`"
}
]
}
},
"@supabase/realtime-js.RealtimeChannel.teardown": {
@@ -110557,6 +110814,11 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
"id": "upload-file-using-arraybuffer-from-base64-file-data",
"name": "Upload file using \`ArrayBuffer\` from base64 file data",
"code": "\`\`\`js\\nimport { decode } from 'base64-arraybuffer'\\n\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .upload('public/avatar1.png', decode('base64FileData'), {\\n contentType: 'image/png'\\n })\\n\`\`\`"
},
{
"id": "handling-errors",
"name": "Handling errors",
"code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .upload('public/avatar1.png', avatarFile)\\n\\nif (error) {\\n // Log the full error so fields like \`statusCode\` and \`error\` (the\\n // Storage error name, e.g. \\"Duplicate\\") aren't hidden behind \`error.message\`.\\n console.error(error)\\n return\\n}\\n\`\`\`"
}
]
}
@@ -113859,8 +114121,8 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
{
"id": "error-handling",
"name": "Error handling",
"code": "\`\`\`js\\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \\"@supabase/supabase-js\\";\\n\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n body: { foo: 'bar' }\\n})\\n\\nif (error instanceof FunctionsHttpError) {\\n const errorMessage = await error.context.json()\\n console.log('Function returned an error', errorMessage)\\n} else if (error instanceof FunctionsRelayError) {\\n console.log('Relay error:', error.message)\\n} else if (error instanceof FunctionsFetchError) {\\n console.log('Fetch error:', error.message)\\n}\\n\`\`\`",
"description": "A \`FunctionsHttpError\` error is returned if your function throws an error, \`FunctionsRelayError\` if the Supabase Relay has an error processing your function and \`FunctionsFetchError\` if there is a network error in calling your function."
"code": "\`\`\`js\\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \\"@supabase/supabase-js\\";\\n\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n body: { foo: 'bar' }\\n})\\n\\nif (error instanceof FunctionsHttpError) {\\n const errorMessage = await error.context.json()\\n console.error('Function returned an error', errorMessage)\\n} else if (error instanceof FunctionsRelayError) {\\n console.error('Relay error:', error)\\n} else if (error instanceof FunctionsFetchError) {\\n console.error('Fetch error:', error)\\n}\\n\`\`\`",
"description": "A \`FunctionsHttpError\` error is returned if your function throws an error, \`FunctionsRelayError\` if the Supabase Relay has an error processing your function and \`FunctionsFetchError\` if there is a network error in calling your function. Log the full error object so fields like \`name\`, \`context\`, and any structured body aren't hidden."
},
{
"id": "passing-custom-headers",
apps/docs/spec/api_v1_openapi.json
+42 -8
View File
@@ -711,7 +711,7 @@
}
},
"responses": {
"201": {
"200": {
"description": "",
"content": {
"application/json": {
@@ -2824,6 +2824,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": { "description": "Unauthorized" },
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" },
@@ -2832,7 +2835,11 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["vanity_subdomain_read"] }],
"summary": "[Beta] Gets current vanity subdomain config",
"tags": ["Domains"],
"x-badges": [{ "name": "OAuth scope: domains:read", "position": "after" }],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{ "name": "OAuth scope: domains:read", "position": "after" },
{ "name": "Only available on Pro, Team, Enterprise", "position": "before" }
],
"x-endpoint-owners": ["infra", "management-api"],
"x-oauth-scope": "domains:read"
},
@@ -2901,6 +2908,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": { "description": "Unauthorized" },
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" },
@@ -2909,7 +2919,11 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["vanity_subdomain_write"] }],
"summary": "[Beta] Checks vanity subdomain availability",
"tags": ["Domains"],
"x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{ "name": "OAuth scope: domains:write", "position": "after" },
{ "name": "Only available on Pro, Team, Enterprise", "position": "before" }
],
"x-endpoint-owners": ["infra", "management-api"],
"x-oauth-scope": "domains:write"
}
@@ -2947,6 +2961,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": { "description": "Unauthorized" },
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" },
@@ -2955,7 +2972,11 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["vanity_subdomain_write"] }],
"summary": "[Beta] Activates a vanity subdomain for a project.",
"tags": ["Domains"],
"x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{ "name": "OAuth scope: domains:write", "position": "after" },
{ "name": "Only available on Pro, Team, Enterprise", "position": "before" }
],
"x-endpoint-owners": ["infra", "management-api"],
"x-oauth-scope": "domains:write"
}
@@ -3203,6 +3224,9 @@
"responses": {
"201": { "description": "" },
"401": { "description": "Unauthorized" },
"402": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"403": { "description": "Forbidden action" },
"429": { "description": "Rate limit exceeded" },
"500": { "description": "Failed to set up read replica" }
@@ -3210,6 +3234,8 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["infra_read_replicas_write"] }],
"summary": "[Beta] Set up a read replica",
"tags": ["Database"],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [{ "name": "Only available on Pro, Team, Enterprise", "position": "before" }],
"x-endpoint-owners": ["management-api", "infra"]
}
},
@@ -6931,7 +6957,7 @@
}
},
"401": { "description": "Unauthorized" },
"402": { "description": "Feature requires a higher plan" },
"402": { "description": "This feature requires the Enterprise organization plan." },
"403": { "description": "Forbidden action" },
"404": { "description": "Project or backup schedule not found" },
"429": { "description": "Rate limit exceeded" },
@@ -6940,7 +6966,11 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["backups_read"] }],
"summary": "Gets the backup schedule for a project",
"tags": ["Database"],
"x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }],
"x-allowed-plans": ["Enterprise"],
"x-badges": [
{ "name": "OAuth scope: database:read", "position": "after" },
{ "name": "Only available on Enterprise", "position": "before" }
],
"x-endpoint-owners": ["infra"],
"x-oauth-scope": "database:read"
},
@@ -6981,7 +7011,7 @@
},
"400": { "description": "Invalid schedule_for format" },
"401": { "description": "Unauthorized" },
"402": { "description": "Feature requires a higher plan" },
"402": { "description": "This feature requires the Enterprise organization plan." },
"403": { "description": "Forbidden action" },
"404": { "description": "Project or backup schedule not found" },
"429": { "description": "Rate limit exceeded" },
@@ -6990,7 +7020,11 @@
"security": [{ "bearer": [] }, { "fga_permissions": ["backups_write"] }],
"summary": "Updates the backup schedule time for a project",
"tags": ["Database"],
"x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }],
"x-allowed-plans": ["Enterprise"],
"x-badges": [
{ "name": "OAuth scope: database:write", "position": "after" },
{ "name": "Only available on Enterprise", "position": "before" }
],
"x-endpoint-owners": ["infra"],
"x-oauth-scope": "database:write"
}
apps/docs/spec/enrichments/tsdoc_v2/combined.json
+18522 -15308
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/functions.json
+100 -84
View File
@@ -23,7 +23,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 96,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L96"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L96"
}
],
"type": {
@@ -42,7 +42,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 97,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L97"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L97"
}
],
"type": {
@@ -61,7 +61,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 98,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L98"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L98"
}
],
"type": {
@@ -80,7 +80,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 99,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L99"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L99"
}
],
"type": {
@@ -99,7 +99,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 100,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L100"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L100"
}
],
"type": {
@@ -118,7 +118,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 101,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L101"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L101"
}
],
"type": {
@@ -137,7 +137,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 102,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L102"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L102"
}
],
"type": {
@@ -156,7 +156,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 103,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L103"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L103"
}
],
"type": {
@@ -175,7 +175,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 104,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L104"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L104"
}
],
"type": {
@@ -194,7 +194,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 105,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L105"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L105"
}
],
"type": {
@@ -213,7 +213,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 106,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L106"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L106"
}
],
"type": {
@@ -232,7 +232,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 107,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L107"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L107"
}
],
"type": {
@@ -251,7 +251,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 108,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L108"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L108"
}
],
"type": {
@@ -270,7 +270,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 109,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L109"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L109"
}
],
"type": {
@@ -289,7 +289,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 110,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L110"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L110"
}
],
"type": {
@@ -309,7 +309,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 95,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L95"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L95"
}
]
},
@@ -339,7 +339,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 44,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L44"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44"
}
],
"signatures": [
@@ -393,7 +393,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 44,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L44"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44"
}
],
"parameters": [
@@ -436,7 +436,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 52,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L52"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L52"
}
],
"type": {
@@ -665,7 +665,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 51,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L51"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L51"
}
],
"type": {
@@ -702,7 +702,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 53,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L53"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L53"
}
],
"type": {
@@ -725,7 +725,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 50,
"character": 7,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L50"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L50"
}
]
}
@@ -755,7 +755,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 19,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L19"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L19"
}
],
"type": {
@@ -984,7 +984,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 17,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L17"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L17"
}
],
"type": {
@@ -1020,7 +1020,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 18,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L18"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L18"
}
],
"type": {
@@ -1043,7 +1043,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 16,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L16"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L16"
}
],
"type": {
@@ -1062,7 +1062,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 202,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L202"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202"
}
],
"signatures": [
@@ -1258,7 +1258,23 @@
},
{
"kind": "text",
"text": " if there is a network error in calling your function."
"text": " if there is a network error in calling your function. Log the full error object so fields like "
},
{
"kind": "code",
"text": "`name`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`context`"
},
{
"kind": "text",
"text": ", and any structured body aren't hidden."
}
]
},
@@ -1268,7 +1284,7 @@
"content": [
{
"kind": "code",
"text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.log('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.log('Relay error:', error.message)\n} else if (error instanceof FunctionsFetchError) {\n console.log('Fetch error:', error.message)\n}\n```"
"text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.error('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.error('Relay error:', error)\n} else if (error instanceof FunctionsFetchError) {\n console.error('Fetch error:', error)\n}\n```"
}
]
},
@@ -1505,7 +1521,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 202,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L202"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202"
}
],
"typeParameters": [
@@ -1604,7 +1620,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 73,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73"
}
],
"signatures": [
@@ -1648,7 +1664,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 73,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73"
}
],
"parameters": [
@@ -1709,7 +1725,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 15,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L15"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L15"
}
]
},
@@ -1750,7 +1766,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 32,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L32"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32"
}
],
"signatures": [
@@ -1765,7 +1781,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 32,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L32"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32"
}
],
"parameters": [
@@ -1836,7 +1852,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -1855,7 +1871,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -1870,7 +1886,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1893,7 +1909,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1912,7 +1928,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1931,7 +1947,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1951,7 +1967,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -1979,7 +1995,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 30,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L30"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L30"
}
],
"extendedTypes": [
@@ -2048,7 +2064,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 58,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L58"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58"
}
],
"signatures": [
@@ -2063,7 +2079,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 58,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L58"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58"
}
],
"parameters": [
@@ -2111,7 +2127,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2137,7 +2153,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2154,7 +2170,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2177,7 +2193,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2196,7 +2212,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2215,7 +2231,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2235,7 +2251,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2273,7 +2289,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 57,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L57"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L57"
}
],
"extendedTypes": [
@@ -2322,7 +2338,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 90,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L90"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90"
}
],
"signatures": [
@@ -2337,7 +2353,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 90,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L90"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90"
}
],
"parameters": [
@@ -2385,7 +2401,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2411,7 +2427,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2428,7 +2444,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2451,7 +2467,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2470,7 +2486,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2489,7 +2505,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2509,7 +2525,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2547,7 +2563,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 89,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L89"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L89"
}
],
"extendedTypes": [
@@ -2596,7 +2612,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 74,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L74"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74"
}
],
"signatures": [
@@ -2611,7 +2627,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 74,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L74"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74"
}
],
"parameters": [
@@ -2659,7 +2675,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2685,7 +2701,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2702,7 +2718,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2725,7 +2741,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2744,7 +2760,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2763,7 +2779,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2783,7 +2799,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2821,7 +2837,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 73,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L73"
}
],
"extendedTypes": [
@@ -2844,7 +2860,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 113,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L113"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113"
}
],
"type": {
@@ -2877,7 +2893,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 129,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L129"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L129"
}
],
"type": {
@@ -2986,7 +3002,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"type": {
@@ -3002,7 +3018,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"indexSignatures": [
@@ -3017,7 +3033,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"parameters": [
@@ -3063,7 +3079,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 121,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L121"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L121"
}
],
"type": {
@@ -3113,7 +3129,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 125,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L125"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L125"
}
],
"type": {
@@ -3144,7 +3160,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 140,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L140"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L140"
}
],
"type": {
@@ -3178,7 +3194,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 145,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L145"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L145"
}
],
"type": {
@@ -3198,7 +3214,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 113,
"character": 36,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L113"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113"
}
]
}
@@ -3215,7 +3231,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 16,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L16"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L16"
}
],
"typeParameters": [
apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json
+100 -84
View File
@@ -23,7 +23,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 96,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L96"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L96"
}
],
"type": {
@@ -42,7 +42,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 97,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L97"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L97"
}
],
"type": {
@@ -61,7 +61,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 98,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L98"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L98"
}
],
"type": {
@@ -80,7 +80,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 99,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L99"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L99"
}
],
"type": {
@@ -99,7 +99,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 100,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L100"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L100"
}
],
"type": {
@@ -118,7 +118,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 101,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L101"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L101"
}
],
"type": {
@@ -137,7 +137,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 102,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L102"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L102"
}
],
"type": {
@@ -156,7 +156,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 103,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L103"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L103"
}
],
"type": {
@@ -175,7 +175,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 104,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L104"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L104"
}
],
"type": {
@@ -194,7 +194,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 105,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L105"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L105"
}
],
"type": {
@@ -213,7 +213,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 106,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L106"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L106"
}
],
"type": {
@@ -232,7 +232,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 107,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L107"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L107"
}
],
"type": {
@@ -251,7 +251,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 108,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L108"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L108"
}
],
"type": {
@@ -270,7 +270,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 109,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L109"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L109"
}
],
"type": {
@@ -289,7 +289,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 110,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L110"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L110"
}
],
"type": {
@@ -309,7 +309,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 95,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L95"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L95"
}
]
},
@@ -339,7 +339,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 44,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L44"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44"
}
],
"signatures": [
@@ -393,7 +393,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 44,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L44"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44"
}
],
"parameters": [
@@ -436,7 +436,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 52,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L52"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L52"
}
],
"type": {
@@ -665,7 +665,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 51,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L51"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L51"
}
],
"type": {
@@ -702,7 +702,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 53,
"character": 6,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L53"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L53"
}
],
"type": {
@@ -725,7 +725,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 50,
"character": 7,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L50"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L50"
}
]
}
@@ -755,7 +755,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 19,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L19"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L19"
}
],
"type": {
@@ -984,7 +984,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 17,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L17"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L17"
}
],
"type": {
@@ -1020,7 +1020,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 18,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L18"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L18"
}
],
"type": {
@@ -1043,7 +1043,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 16,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L16"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L16"
}
],
"type": {
@@ -1062,7 +1062,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 202,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L202"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202"
}
],
"signatures": [
@@ -1258,7 +1258,23 @@
},
{
"kind": "text",
"text": " if there is a network error in calling your function."
"text": " if there is a network error in calling your function. Log the full error object so fields like "
},
{
"kind": "code",
"text": "`name`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`context`"
},
{
"kind": "text",
"text": ", and any structured body aren't hidden."
}
]
},
@@ -1268,7 +1284,7 @@
"content": [
{
"kind": "code",
"text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.log('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.log('Relay error:', error.message)\n} else if (error instanceof FunctionsFetchError) {\n console.log('Fetch error:', error.message)\n}\n```"
"text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.error('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.error('Relay error:', error)\n} else if (error instanceof FunctionsFetchError) {\n console.error('Fetch error:', error)\n}\n```"
}
]
},
@@ -1505,7 +1521,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 202,
"character": 8,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L202"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202"
}
],
"typeParameters": [
@@ -1604,7 +1620,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 73,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73"
}
],
"signatures": [
@@ -1648,7 +1664,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 73,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73"
}
],
"parameters": [
@@ -1709,7 +1725,7 @@
"fileName": "packages/core/functions-js/src/FunctionsClient.ts",
"line": 15,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/FunctionsClient.ts#L15"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L15"
}
]
},
@@ -1750,7 +1766,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 32,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L32"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32"
}
],
"signatures": [
@@ -1765,7 +1781,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 32,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L32"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32"
}
],
"parameters": [
@@ -1836,7 +1852,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -1855,7 +1871,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -1870,7 +1886,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1893,7 +1909,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1912,7 +1928,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1931,7 +1947,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -1951,7 +1967,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -1979,7 +1995,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 30,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L30"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L30"
}
],
"extendedTypes": [
@@ -2048,7 +2064,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 58,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L58"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58"
}
],
"signatures": [
@@ -2063,7 +2079,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 58,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L58"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58"
}
],
"parameters": [
@@ -2111,7 +2127,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2137,7 +2153,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2154,7 +2170,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2177,7 +2193,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2196,7 +2212,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2215,7 +2231,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2235,7 +2251,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2273,7 +2289,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 57,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L57"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L57"
}
],
"extendedTypes": [
@@ -2322,7 +2338,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 90,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L90"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90"
}
],
"signatures": [
@@ -2337,7 +2353,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 90,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L90"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90"
}
],
"parameters": [
@@ -2385,7 +2401,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2411,7 +2427,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2428,7 +2444,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2451,7 +2467,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2470,7 +2486,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2489,7 +2505,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2509,7 +2525,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2547,7 +2563,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 89,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L89"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L89"
}
],
"extendedTypes": [
@@ -2596,7 +2612,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 74,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L74"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74"
}
],
"signatures": [
@@ -2611,7 +2627,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 74,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L74"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74"
}
],
"parameters": [
@@ -2659,7 +2675,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 31,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L31"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31"
}
],
"type": {
@@ -2685,7 +2701,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"signatures": [
@@ -2702,7 +2718,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2725,7 +2741,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 45,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2744,7 +2760,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 28,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2763,7 +2779,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
],
"type": {
@@ -2783,7 +2799,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 38,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L38"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38"
}
]
}
@@ -2821,7 +2837,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 73,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L73"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L73"
}
],
"extendedTypes": [
@@ -2844,7 +2860,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 113,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L113"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113"
}
],
"type": {
@@ -2877,7 +2893,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 129,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L129"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L129"
}
],
"type": {
@@ -2986,7 +3002,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"type": {
@@ -3002,7 +3018,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"indexSignatures": [
@@ -3017,7 +3033,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 117,
"character": 14,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L117"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117"
}
],
"parameters": [
@@ -3063,7 +3079,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 121,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L121"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L121"
}
],
"type": {
@@ -3113,7 +3129,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 125,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L125"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L125"
}
],
"type": {
@@ -3144,7 +3160,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 140,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L140"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L140"
}
],
"type": {
@@ -3178,7 +3194,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 145,
"character": 2,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L145"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L145"
}
],
"type": {
@@ -3198,7 +3214,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 113,
"character": 36,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L113"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113"
}
]
}
@@ -3215,7 +3231,7 @@
"fileName": "packages/core/functions-js/src/types.ts",
"line": 16,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/a5f09cf9a0a8c2744464a8505333ab3136e3f290/packages/core/functions-js/src/types.ts#L16"
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L16"
}
],
"typeParameters": [
apps/docs/spec/enrichments/tsdoc_v2/gotrue.json
+5060 -4108
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json
+5060 -4108
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/postgrest.json
+1189 -753
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json
+1189 -753
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/realtime.json
+780 -682
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json
+780 -682
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/storage.json
+952 -942
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json
+952 -942
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/supabase.json
+10437 -8732
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json
+10437 -8732
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/transforms/api_v1_openapi_deparsed.json
+47 -3
View File
@@ -1914,7 +1914,7 @@
}
},
"responses": {
"201": {
"200": {
"description": "",
"content": {
"application/json": {
@@ -7468,6 +7468,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": {
"description": "Unauthorized"
},
@@ -7491,10 +7494,15 @@
],
"summary": "[Beta] Gets current vanity subdomain config",
"tags": ["Domains"],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{
"name": "OAuth scope: domains:read",
"position": "after"
},
{
"name": "Only available on Pro, Team, Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["infra", "management-api"],
@@ -7609,6 +7617,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": {
"description": "Unauthorized"
},
@@ -7632,10 +7643,15 @@
],
"summary": "[Beta] Checks vanity subdomain availability",
"tags": ["Domains"],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{
"name": "OAuth scope: domains:write",
"position": "after"
},
{
"name": "Only available on Pro, Team, Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["infra", "management-api"],
@@ -7697,6 +7713,9 @@
}
}
},
"400": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"401": {
"description": "Unauthorized"
},
@@ -7720,10 +7739,15 @@
],
"summary": "[Beta] Activates a vanity subdomain for a project.",
"tags": ["Domains"],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{
"name": "OAuth scope: domains:write",
"position": "after"
},
{
"name": "Only available on Pro, Team, Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["infra", "management-api"],
@@ -8465,6 +8489,9 @@
"401": {
"description": "Unauthorized"
},
"402": {
"description": "This feature requires the Pro, Team, or Enterprise organization plan."
},
"403": {
"description": "Forbidden action"
},
@@ -8485,6 +8512,13 @@
],
"summary": "[Beta] Set up a read replica",
"tags": ["Database"],
"x-allowed-plans": ["Pro", "Team", "Enterprise"],
"x-badges": [
{
"name": "Only available on Pro, Team, Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["management-api", "infra"]
}
},
@@ -21669,7 +21703,7 @@
"description": "Unauthorized"
},
"402": {
"description": "Feature requires a higher plan"
"description": "This feature requires the Enterprise organization plan."
},
"403": {
"description": "Forbidden action"
@@ -21694,10 +21728,15 @@
],
"summary": "Gets the backup schedule for a project",
"tags": ["Database"],
"x-allowed-plans": ["Enterprise"],
"x-badges": [
{
"name": "OAuth scope: database:read",
"position": "after"
},
{
"name": "Only available on Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["infra"],
@@ -21774,7 +21813,7 @@
"description": "Unauthorized"
},
"402": {
"description": "Feature requires a higher plan"
"description": "This feature requires the Enterprise organization plan."
},
"403": {
"description": "Forbidden action"
@@ -21799,10 +21838,15 @@
],
"summary": "Updates the backup schedule time for a project",
"tags": ["Database"],
"x-allowed-plans": ["Enterprise"],
"x-badges": [
{
"name": "OAuth scope: database:write",
"position": "after"
},
{
"name": "Only available on Enterprise",
"position": "before"
}
],
"x-endpoint-owners": ["infra"],