{
"id": 0,
"name": "@supabase/supabase-js",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 12,
"name": "cors",
"variant": "declaration",
"kind": 2,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Canonical CORS configuration for Supabase Edge Functions\n\nThis module exports CORS headers that stay synchronized with the Supabase SDK.\nWhen new headers are added to the SDK, they are automatically included here,\npreventing CORS errors in Edge Functions."
}
],
"blockTags": [
{
"tag": "@example",
"name": "Basic usage",
"content": [
{
"kind": "code",
"text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```"
}
]
}
]
},
"children": [
{
"id": 13,
"name": "CorsHeaders",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Type representing CORS headers as a record of header names to values"
}
]
},
"sources": [
{
"fileName": "packages/core/supabase-js/src/cors.ts",
"line": 47,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/supabase-js/src/cors.ts#L47"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "string"
}
],
"name": "Record",
"package": "typescript"
}
},
{
"id": 14,
"name": "corsHeaders",
"variant": "declaration",
"kind": 32,
"flags": {
"isConst": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Default CORS headers for Supabase Edge Functions.\n\nIncludes all headers sent by Supabase client libraries and allows all standard HTTP methods.\nUse this for simple CORS configurations with wildcard origin."
}
],
"blockTags": [
{
"tag": "@example",
"name": "Basic usage",
"content": [
{
"kind": "code",
"text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/supabase-js/src/cors.ts",
"line": 71,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/supabase-js/src/cors.ts#L71"
}
],
"type": {
"type": "reference",
"target": 13,
"name": "CorsHeaders",
"package": "@supabase/supabase-js"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Type Aliases",
"children": [13]
},
{
"title": "Variables",
"children": [14]
}
],
"sources": [
{
"fileName": "packages/core/supabase-js/src/cors.ts",
"line": 1,
"character": 0,
"url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/supabase-js/src/cors.ts#L1"
}
]
},
{
"id": 1,
"name": "index",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
"id": 102,
"name": "FunctionRegion",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 103,
"name": "Any",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "literal",
"value": "any"
}
},
{
"id": 104,
"name": "ApNortheast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 73,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-northeast-1"
}
},
{
"id": 105,
"name": "ApNortheast2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 74,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-northeast-2"
}
},
{
"id": 106,
"name": "ApSouth1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 75,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-south-1"
}
},
{
"id": 107,
"name": "ApSoutheast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 76,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-southeast-1"
}
},
{
"id": 108,
"name": "ApSoutheast2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-southeast-2"
}
},
{
"id": 109,
"name": "CaCentral1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 78,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ca-central-1"
}
},
{
"id": 110,
"name": "EuCentral1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 79,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-central-1"
}
},
{
"id": 111,
"name": "EuWest1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 80,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-1"
}
},
{
"id": 112,
"name": "EuWest2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 81,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-2"
}
},
{
"id": 113,
"name": "EuWest3",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 82,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-3"
}
},
{
"id": 114,
"name": "SaEast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 83,
"character": 4
}
],
"type": {
"type": "literal",
"value": "sa-east-1"
}
},
{
"id": 115,
"name": "UsEast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 84,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-east-1"
}
},
{
"id": 116,
"name": "UsWest1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 85,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-west-1"
}
},
{
"id": 117,
"name": "UsWest2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 86,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-west-2"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [
103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117
]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 71,
"character": 20
}
]
},
{
"id": 2365,
"name": "REALTIME_LISTEN_TYPES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 2366,
"name": "BROADCAST",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 122,
"character": 4
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 2368,
"name": "POSTGRES_CHANGES",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 124,
"character": 4
}
],
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 2367,
"name": "PRESENCE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 123,
"character": 4
}
],
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 2369,
"name": "SYSTEM",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 125,
"character": 4
}
],
"type": {
"type": "literal",
"value": "system"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [2366, 2368, 2367, 2369]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 121,
"character": 20
}
]
},
{
"id": 2370,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 2371,
"name": "ALL",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 116,
"character": 4
}
],
"type": {
"type": "literal",
"value": "*"
}
},
{
"id": 2374,
"name": "DELETE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 119,
"character": 4
}
],
"type": {
"type": "literal",
"value": "DELETE"
}
},
{
"id": 2372,
"name": "INSERT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 117,
"character": 4
}
],
"type": {
"type": "literal",
"value": "INSERT"
}
},
{
"id": 2373,
"name": "UPDATE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 118,
"character": 4
}
],
"type": {
"type": "literal",
"value": "UPDATE"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [2371, 2374, 2372, 2373]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 115,
"character": 20
}
]
},
{
"id": 2375,
"name": "REALTIME_PRESENCE_LISTEN_EVENTS",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 2377,
"name": "JOIN",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts",
"line": 30,
"character": 4
}
],
"type": {
"type": "literal",
"value": "join"
}
},
{
"id": 2378,
"name": "LEAVE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts",
"line": 31,
"character": 4
}
],
"type": {
"type": "literal",
"value": "leave"
}
},
{
"id": 2376,
"name": "SYNC",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts",
"line": 29,
"character": 4
}
],
"type": {
"type": "literal",
"value": "sync"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [2377, 2378, 2376]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts",
"line": 28,
"character": 20
}
]
},
{
"id": 2379,
"name": "REALTIME_SUBSCRIBE_STATES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 2383,
"name": "CHANNEL_ERROR",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 131,
"character": 4
}
],
"type": {
"type": "literal",
"value": "CHANNEL_ERROR"
}
},
{
"id": 2382,
"name": "CLOSED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 130,
"character": 4
}
],
"type": {
"type": "literal",
"value": "CLOSED"
}
},
{
"id": 2380,
"name": "SUBSCRIBED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 128,
"character": 4
}
],
"type": {
"type": "literal",
"value": "SUBSCRIBED"
}
},
{
"id": 2381,
"name": "TIMED_OUT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 129,
"character": 4
}
],
"type": {
"type": "literal",
"value": "TIMED_OUT"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [2383, 2382, 2380, 2381]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 127,
"character": 20
}
]
},
{
"id": 1641,
"name": "AuthApiError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error returned directly from the GoTrue REST API."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```"
}
]
}
]
},
"children": [
{
"id": 1642,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 39,
"character": 4
}
],
"signatures": [
{
"id": 1643,
"name": "AuthApiError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 39,
"character": 4
}
],
"parameters": [
{
"id": 1644,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1645,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1646,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"target": 1641,
"name": "AuthApiError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1633,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1632,
"name": "AuthError.constructor"
}
},
{
"id": 1650,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1640,
"name": "AuthError.__isAuthError"
}
},
{
"id": 1648,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1649,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1637,
"name": "AuthError.code"
}
},
{
"id": 1647,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 38,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"target": 1639,
"name": "AuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1642]
},
{
"title": "Properties",
"children": [1650, 1648, 1647]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 37,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1631,
"name": "AuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1631,
"name": "AuthError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Base error thrown by Supabase Auth helpers."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```"
}
]
}
]
},
"children": [
{
"id": 1632,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 24,
"character": 4
}
],
"signatures": [
{
"id": 1633,
"name": "AuthError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 24,
"character": 4
}
],
"parameters": [
{
"id": 1634,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1635,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1636,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 1631,
"name": "AuthError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
},
{
"id": 1640,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 1637,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1638,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 1639,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 22,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1632]
},
{
"title": "Properties",
"children": [1640, 1637, 1639]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 13,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Error"
},
"name": "Error",
"package": "typescript"
}
],
"extendedBy": [
{
"type": "reference",
"target": 1641,
"name": "AuthApiError"
},
{
"type": "reference",
"target": 1651,
"name": "AuthUnknownError"
},
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError"
}
]
},
{
"id": 1698,
"name": "AuthImplicitGrantRedirectError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when implicit grant redirects contain an error."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```"
}
]
}
]
},
"children": [
{
"id": 1699,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 133,
"character": 4
}
],
"signatures": [
{
"id": 1700,
"name": "AuthImplicitGrantRedirectError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 133,
"character": 4
}
],
"parameters": [
{
"id": 1701,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1702,
"name": "details",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1703,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1705,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 135,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1704,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 134,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1705, 1704]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 133,
"character": 43
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"target": 1698,
"name": "AuthImplicitGrantRedirectError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1724,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1722,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1723,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1706,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 129,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1707,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1709,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 131,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1708,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 130,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1709, 1708]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 129,
"character": 13
}
]
}
}
]
}
},
{
"id": 1720,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1721,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
},
{
"id": 1710,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 137,
"character": 4
}
],
"signatures": [
{
"id": 1711,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 137,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1712,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1716,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 141,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1717,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1719,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 143,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1718,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 142,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1719, 1718]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 141,
"character": 17
}
]
}
}
]
}
},
{
"id": 1714,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 139,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1713,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 138,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1715,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 140,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1716, 1714, 1713, 1715]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 137,
"character": 14
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [1699]
},
{
"title": "Properties",
"children": [1724, 1722, 1706, 1720, 1721]
},
{
"title": "Methods",
"children": [1710]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 128,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1689,
"name": "AuthInvalidCredentialsError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when email/password credentials are invalid."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```"
}
]
}
]
},
"children": [
{
"id": 1690,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 113,
"character": 4
}
],
"signatures": [
{
"id": 1691,
"name": "AuthInvalidCredentialsError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 113,
"character": 4
}
],
"parameters": [
{
"id": 1692,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 1689,
"name": "AuthInvalidCredentialsError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1697,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1695,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1696,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1693,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1694,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1690]
},
{
"title": "Properties",
"children": [1697, 1695, 1693, 1694]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 112,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1782,
"name": "AuthInvalidJwtError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when a JWT cannot be verified or parsed."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```"
}
]
}
]
},
"children": [
{
"id": 1783,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 241,
"character": 4
}
],
"signatures": [
{
"id": 1784,
"name": "AuthInvalidJwtError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 241,
"character": 4
}
],
"parameters": [
{
"id": 1785,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 1782,
"name": "AuthInvalidJwtError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1790,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1788,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1789,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1786,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1787,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1783]
},
{
"title": "Properties",
"children": [1790, 1788, 1786, 1787]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 240,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1681,
"name": "AuthInvalidTokenResponseError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when the token response is malformed."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```"
}
]
}
]
},
"children": [
{
"id": 1682,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 100,
"character": 4
}
],
"signatures": [
{
"id": 1683,
"name": "AuthInvalidTokenResponseError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 100,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1681,
"name": "AuthInvalidTokenResponseError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1688,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1686,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1687,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1684,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1685,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1682]
},
{
"title": "Properties",
"children": [1688, 1686, 1684, 1685]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 99,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1752,
"name": "AuthPKCECodeVerifierMissingError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```"
}
]
}
]
},
"children": [
{
"id": 1753,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 190,
"character": 4
}
],
"signatures": [
{
"id": 1754,
"name": "AuthPKCECodeVerifierMissingError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 190,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1752,
"name": "AuthPKCECodeVerifierMissingError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1759,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1757,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1758,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1755,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1756,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1753]
},
{
"title": "Properties",
"children": [1759, 1757, 1755, 1756]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 189,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1725,
"name": "AuthPKCEGrantCodeExchangeError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown during PKCE code exchanges."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```"
}
]
}
]
},
"children": [
{
"id": 1726,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 163,
"character": 4
}
],
"signatures": [
{
"id": 1727,
"name": "AuthPKCEGrantCodeExchangeError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 163,
"character": 4
}
],
"parameters": [
{
"id": 1728,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1729,
"name": "details",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1730,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1732,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 165,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1731,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 164,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1732, 1731]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 163,
"character": 43
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"target": 1725,
"name": "AuthPKCEGrantCodeExchangeError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1751,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1749,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1750,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1733,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 159,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1734,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1736,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 161,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1735,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 160,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1736, 1735]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 159,
"character": 13
}
]
}
}
]
}
},
{
"id": 1747,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1748,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
},
{
"id": 1737,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 167,
"character": 4
}
],
"signatures": [
{
"id": 1738,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 167,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1739,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1743,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 171,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1744,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1746,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 173,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1745,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 172,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1746, 1745]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 171,
"character": 17
}
]
}
}
]
}
},
{
"id": 1741,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 169,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1740,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 168,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1742,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 170,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1743, 1741, 1740, 1742]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 167,
"character": 14
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [1726]
},
{
"title": "Properties",
"children": [1751, 1749, 1733, 1747, 1748]
},
{
"title": "Methods",
"children": [1737]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 158,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1760,
"name": "AuthRetryableFetchError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when a transient fetch issue occurs."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```"
}
]
}
]
},
"children": [
{
"id": 1761,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 204,
"character": 4
}
],
"signatures": [
{
"id": 1762,
"name": "AuthRetryableFetchError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 204,
"character": 4
}
],
"parameters": [
{
"id": 1763,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1764,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"target": 1760,
"name": "AuthRetryableFetchError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1769,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1767,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1768,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1765,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1766,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1761]
},
{
"title": "Properties",
"children": [1769, 1767, 1765, 1766]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 203,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1673,
"name": "AuthSessionMissingError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when an operation requires a session but none is present."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```"
}
]
}
]
},
"children": [
{
"id": 1674,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 86,
"character": 4
}
],
"signatures": [
{
"id": 1675,
"name": "AuthSessionMissingError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 86,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1673,
"name": "AuthSessionMissingError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1680,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1678,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1679,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1676,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1677,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1674]
},
{
"title": "Properties",
"children": [1680, 1678, 1676, 1677]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 85,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1651,
"name": "AuthUnknownError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Wraps non-standard errors so callers can inspect the root cause."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```"
}
]
}
]
},
"children": [
{
"id": 1652,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 58,
"character": 4
}
],
"signatures": [
{
"id": 1653,
"name": "AuthUnknownError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 58,
"character": 4
}
],
"parameters": [
{
"id": 1654,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1655,
"name": "originalError",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"target": 1651,
"name": "AuthUnknownError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1633,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1632,
"name": "AuthError.constructor"
}
},
{
"id": 1660,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1640,
"name": "AuthError.__isAuthError"
}
},
{
"id": 1657,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1658,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1637,
"name": "AuthError.code"
}
},
{
"id": 1656,
"name": "originalError",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 57,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "unknown"
}
},
{
"id": 1659,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 22,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1639,
"name": "AuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1652]
},
{
"title": "Properties",
"children": [1660, 1657, 1656, 1659]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 56,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1631,
"name": "AuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1770,
"name": "AuthWeakPasswordError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when a supplied password is considered weak."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```"
}
]
}
]
},
"children": [
{
"id": 1771,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 227,
"character": 4
}
],
"signatures": [
{
"id": 1772,
"name": "AuthWeakPasswordError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 227,
"character": 4
}
],
"parameters": [
{
"id": 1773,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1774,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1775,
"name": "reasons",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "union",
"types": [
{
"type": "literal",
"value": "length"
},
{
"type": "literal",
"value": "characters"
},
{
"type": "literal",
"value": "pwned"
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 1770,
"name": "AuthWeakPasswordError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1663,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1662,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1781,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1672,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 1779,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1780,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1670,
"name": "CustomAuthError.code"
}
},
{
"id": 1777,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 1668,
"name": "CustomAuthError.name"
}
},
{
"id": 1776,
"name": "reasons",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Reasons why the password is deemed weak."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 226,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "union",
"types": [
{
"type": "literal",
"value": "length"
},
{
"type": "literal",
"value": "characters"
},
{
"type": "literal",
"value": "pwned"
}
]
}
}
},
{
"id": 1778,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 1669,
"name": "CustomAuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1771]
},
{
"title": "Properties",
"children": [1781, 1779, 1777, 1776, 1778]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 222,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 1661,
"name": "CustomAuthError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Flexible error class used to create named auth errors at runtime."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```"
}
]
}
]
},
"children": [
{
"id": 1662,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 73,
"character": 4
}
],
"signatures": [
{
"id": 1663,
"name": "CustomAuthError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 73,
"character": 4
}
],
"parameters": [
{
"id": 1664,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1665,
"name": "name",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1666,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1667,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"target": 1661,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 1633,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 1632,
"name": "AuthError.constructor"
}
},
{
"id": 1672,
"name": "__isAuthError",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 23,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"target": 1640,
"name": "AuthError.__isAuthError"
}
},
{
"id": 1670,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase "
},
{
"kind": "inline-tag",
"tag": "@link",
"text": "#status"
},
{
"kind": "text",
"text": " will also be undefined."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 20,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"target": {
"sourceFileName": "../auth-js/src/lib/error-codes.ts",
"qualifiedName": "ErrorCode"
},
"name": "ErrorCode",
"package": "@supabase/auth-js"
},
{
"type": "intersection",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reflection",
"declaration": {
"id": 1671,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 1637,
"name": "AuthError.code"
}
},
{
"id": 1668,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 71,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "AuthError.name"
}
},
{
"id": 1669,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "HTTP status code that caused the error."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 72,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"target": 1639,
"name": "AuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [1662]
},
{
"title": "Properties",
"children": [1672, 1670, 1668, 1669]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 70,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 1631,
"name": "AuthError",
"package": "@supabase/auth-js"
}
],
"extendedBy": [
{
"type": "reference",
"target": 1673,
"name": "AuthSessionMissingError"
},
{
"type": "reference",
"target": 1681,
"name": "AuthInvalidTokenResponseError"
},
{
"type": "reference",
"target": 1689,
"name": "AuthInvalidCredentialsError"
},
{
"type": "reference",
"target": 1698,
"name": "AuthImplicitGrantRedirectError"
},
{
"type": "reference",
"target": 1725,
"name": "AuthPKCEGrantCodeExchangeError"
},
{
"type": "reference",
"target": 1752,
"name": "AuthPKCECodeVerifierMissingError"
},
{
"type": "reference",
"target": 1760,
"name": "AuthRetryableFetchError"
},
{
"type": "reference",
"target": 1770,
"name": "AuthWeakPasswordError"
},
{
"type": "reference",
"target": 1782,
"name": "AuthInvalidJwtError"
}
]
},
{
"id": 95,
"name": "FunctionsError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Base error for Supabase Edge Function invocations."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```"
}
]
}
]
},
"children": [
{
"id": 96,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 30,
"character": 4
}
],
"signatures": [
{
"id": 97,
"name": "FunctionsError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 30,
"character": 4
}
],
"parameters": [
{
"id": 98,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 99,
"name": "name",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 100,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 95,
"name": "FunctionsError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
},
{
"id": 101,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 29,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [96]
},
{
"title": "Properties",
"children": [101]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 28,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Error"
},
"name": "Error",
"package": "typescript"
}
],
"extendedBy": [
{
"type": "reference",
"target": 80,
"name": "FunctionsHttpError"
},
{
"type": "reference",
"target": 85,
"name": "FunctionsFetchError"
},
{
"type": "reference",
"target": 90,
"name": "FunctionsRelayError"
}
]
},
{
"id": 85,
"name": "FunctionsFetchError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when the network request to an Edge Function fails."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```"
}
]
}
]
},
"children": [
{
"id": 86,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 43,
"character": 4
}
],
"signatures": [
{
"id": 87,
"name": "FunctionsFetchError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 43,
"character": 4
}
],
"parameters": [
{
"id": 88,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 85,
"name": "FunctionsFetchError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 97,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 96,
"name": "FunctionsError.constructor"
}
},
{
"id": 89,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 29,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"target": 101,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [86]
},
{
"title": "Properties",
"children": [89]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 42,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 95,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 80,
"name": "FunctionsHttpError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when the Edge Function returns a non-2xx status code."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```"
}
]
}
]
},
"children": [
{
"id": 81,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 69,
"character": 4
}
],
"signatures": [
{
"id": 82,
"name": "FunctionsHttpError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 69,
"character": 4
}
],
"parameters": [
{
"id": 83,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 80,
"name": "FunctionsHttpError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 97,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 96,
"name": "FunctionsError.constructor"
}
},
{
"id": 84,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 29,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"target": 101,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [81]
},
{
"title": "Properties",
"children": [84]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 68,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 95,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 90,
"name": "FunctionsRelayError",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Error thrown when the Supabase relay cannot reach the Edge Function."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```"
}
]
}
]
},
"children": [
{
"id": 91,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 56,
"character": 4
}
],
"signatures": [
{
"id": 92,
"name": "FunctionsRelayError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 56,
"character": 4
}
],
"parameters": [
{
"id": 93,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 90,
"name": "FunctionsRelayError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 97,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 96,
"name": "FunctionsError.constructor"
}
},
{
"id": 94,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 29,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"target": 101,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [91]
},
{
"title": "Properties",
"children": [94]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 55,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 95,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 293,
"name": "GoTrueAdminApi",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 294,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 32,
"character": 4
}
],
"signatures": [
{
"id": 295,
"name": "GoTrueAdminApi",
"variant": "signature",
"kind": 16384,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates an admin API client that can be used to manage users and OAuth clients."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SERVICE_ROLE_KEY}` },\n})\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 32,
"character": 4
}
],
"parameters": [
{
"id": 296,
"name": "__namedParameters",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 297,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 303,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 37,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 304,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
},
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"signatures": [
{
"id": 305,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
}
],
"parameters": [
{
"id": 306,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInfo"
},
"name": "RequestInfo",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 307,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
},
{
"id": 308,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"parameters": [
{
"id": 309,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Request"
},
"name": "Request",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 310,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
}
},
{
"id": 299,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 34,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 300,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 34,
"character": 18
}
],
"indexSignatures": [
{
"id": 301,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 35,
"character": 12
}
],
"parameters": [
{
"id": 302,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 298,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [303, 299, 298]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 32,
"character": 42
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 293,
"name": "GoTrueAdminApi",
"package": "@supabase/auth-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 313,
"name": "customProviders",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Contains all custom OIDC/OAuth provider administration methods."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 13,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1538,
"name": "GoTrueAdminCustomProvidersApi",
"package": "@supabase/auth-js"
}
},
{
"id": 319,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 18,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 320,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
},
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"signatures": [
{
"id": 321,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
"line": 29329,
"character": 17
}
],
"parameters": [
{
"id": 322,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInfo"
},
"name": "RequestInfo",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 323,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
},
{
"id": 324,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
}
]
},
"sources": [
{
"fileName": "node_modules/@types/node/globals.d.ts",
"line": 289,
"character": 13
}
],
"parameters": [
{
"id": 325,
"name": "input",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Request"
},
"name": "Request",
"package": "typescript"
},
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "URL"
},
"name": "URL",
"package": "typescript"
}
]
}
},
{
"id": 326,
"name": "init",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "RequestInit"
},
"name": "RequestInit",
"package": "typescript"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
"qualifiedName": "Response"
},
"name": "Response",
"package": "typescript"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
}
}
},
{
"id": 315,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 316,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 15,
"character": 23
}
],
"indexSignatures": [
{
"id": 317,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 16,
"character": 8
}
],
"parameters": [
{
"id": 318,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 311,
"name": "mfa",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Contains all MFA administration methods."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 6,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1294,
"name": "GoTrueAdminMFAApi",
"package": "@supabase/auth-js"
}
},
{
"id": 312,
"name": "oauth",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 11,
"character": 4
}
],
"type": {
"type": "reference",
"target": 1423,
"name": "GoTrueAdminOAuthApi",
"package": "@supabase/auth-js"
}
},
{
"id": 314,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 14,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 344,
"name": "createUser",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 315,
"character": 4
}
],
"signatures": [
{
"id": 345,
"name": "createUser",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Creates a new user.\nThis function should only be called on a server. Never expose your "
},
{
"kind": "code",
"text": "`service_role`"
},
{
"kind": "text",
"text": " key in the browser."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Auth"
}
]
},
{
"tag": "@remarks",
"content": [
{
"kind": "text",
"text": "- To confirm the user's email address or phone number, set "
},
{
"kind": "code",
"text": "`email_confirm`"
},
{
"kind": "text",
"text": " or "
},
{
"kind": "code",
"text": "`phone_confirm`"
},
{
"kind": "text",
"text": " to true. Both arguments default to false.\n- "
},
{
"kind": "code",
"text": "`createUser()`"
},
{
"kind": "text",
"text": " will not send a confirmation email to the user. You can use ["
},
{
"kind": "code",
"text": "`inviteUserByEmail()`"
},
{
"kind": "text",
"text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the "
},
{
"kind": "code",
"text": "`email_confirm`"
},
{
"kind": "text",
"text": " or "
},
{
"kind": "code",
"text": "`phone_confirm`"
},
{
"kind": "text",
"text": " param to "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": "."
}
]
},
{
"tag": "@example",
"name": "With custom user metadata",
"content": [
{
"kind": "code",
"text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```"
}
]
},
{
"tag": "@exampleResponse",
"content": [
{
"kind": "text",
"text": "With custom user metadata\n"
},
{
"kind": "code",
"text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```"
}
]
},
{
"tag": "@example",
"name": "Auto-confirm the user's email",
"content": [
{
"kind": "code",
"text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```"
}
]
},
{
"tag": "@example",
"name": "Auto-confirm the user's phone number",
"content": [
{
"kind": "code",
"text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 315,
"character": 4
}
],
"parameters": [
{
"id": 346,
"name": "attributes",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 892,
"name": "AdminUserAttributes",
"package": "@supabase/auth-js"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 843,
"name": "UserResponse",
"package": "@supabase/auth-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 368,
"name": "deleteUser",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 589,
"character": 4
}
],
"signatures": [
{
"id": 369,
"name": "deleteUser",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Delete a user. Requires a "
},
{
"kind": "code",
"text": "`service_role`"
},
{
"kind": "text",
"text": " key."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Auth"
}
]
},
{
"tag": "@remarks",
"content": [
{
"kind": "text",
"text": "- The "
},
{
"kind": "code",
"text": "`deleteUser()`"
},
{
"kind": "text",
"text": " method requires the user's ID, which maps to the "
},
{
"kind": "code",
"text": "`auth.users.id`"
},
{
"kind": "text",
"text": " column."
}
]
},
{
"tag": "@example",
"name": "Removes a user",
"content": [
{
"kind": "code",
"text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```"
}
]
},
{
"tag": "@exampleResponse",
"content": [
{
"kind": "text",
"text": "Removes a user\n"
},
{
"kind": "code",
"text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 589,
"character": 4
}
],
"parameters": [
{
"id": 370,
"name": "id",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The user id you want to remove."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 371,
"name": "shouldSoftDelete",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your "
},
{
"kind": "code",
"text": "`service_role`"
},
{
"kind": "text",
"text": " key in the browser."
}
]
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Promise"
},
"typeArguments": [
{
"type": "reference",
"target": 843,
"name": "UserResponse",
"package": "@supabase/auth-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 341,
"name": "generateLink",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 235,
"character": 4
}
],
"signatures": [
{
"id": 342,
"name": "generateLink",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Generates email links and OTPs to be sent via a custom email provider."
}
],
"blockTags": [
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Auth"
}
]
},
{
"tag": "@remarks",
"content": [
{
"kind": "text",
"text": "- The following types can be passed into "
},
{
"kind": "code",
"text": "`generateLink()`"
},
{
"kind": "text",
"text": ": "
},
{
"kind": "code",
"text": "`signup`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`magiclink`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`invite`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`recovery`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`email_change_current`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`email_change_new`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`phone_change`"
},
{
"kind": "text",
"text": ".\n- "
},
{
"kind": "code",
"text": "`generateLink()`"
},
{
"kind": "text",
"text": " only generates the email link for "
},
{
"kind": "code",
"text": "`email_change_email`"
},
{
"kind": "text",
"text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- "
},
{
"kind": "code",
"text": "`generateLink()`"
},
{
"kind": "text",
"text": " handles the creation of the user for "
},
{
"kind": "code",
"text": "`signup`"
},
{
"kind": "text",
"text": ", "
},
{
"kind": "code",
"text": "`invite`"
},
{
"kind": "text",
"text": " and "
},
{
"kind": "code",
"text": "`magiclink`"
},
{
"kind": "text",
"text": "."
}
]
},
{
"tag": "@example",
"name": "Generate a signup link",
"content": [
{
"kind": "code",
"text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```"
}
]
},
{
"tag": "@exampleResponse",
"content": [
{
"kind": "text",
"text": "Generate a signup link\n"
},
{
"kind": "code",
"text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \" \n \n \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n
\n
\n Supabase JS SDK
\n\n Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.
\n\n