{
"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": 54,
"character": 12,
"url": "https://github.com/supabase/supabase-js/blob/84a729bdd73e808f5158b4e1ec07bc14af42c1ae/packages/core/supabase-js/src/cors.ts#L54"
}
],
"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```"
}
]
},
{
"tag": "@category",
"content": [
{
"kind": "text",
"text": "Edge Functions"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/supabase-js/src/cors.ts",
"line": 80,
"character": 13,
"url": "https://github.com/supabase/supabase-js/blob/84a729bdd73e808f5158b4e1ec07bc14af42c1ae/packages/core/supabase-js/src/cors.ts#L80"
}
],
"type": {
"type": "reference",
"target": 13,
"name": "CorsHeaders",
"package": "@supabase/supabase-js"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Type Aliases",
"children": [13]
},
{
"title": "Variables",
"children": [14]
}
],
"categories": [
{
"title": "Edge Functions",
"children": [14]
},
{
"title": "Other",
"children": [13]
}
],
"sources": [
{
"fileName": "packages/core/supabase-js/src/cors.ts",
"line": 1,
"character": 0,
"url": "https://github.com/supabase/supabase-js/blob/84a729bdd73e808f5158b4e1ec07bc14af42c1ae/packages/core/supabase-js/src/cors.ts#L1"
}
]
},
{
"id": 1,
"name": "index",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
"id": 925,
"name": "FunctionRegion",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 926,
"name": "Any",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "literal",
"value": "any"
}
},
{
"id": 927,
"name": "ApNortheast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 78,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-northeast-1"
}
},
{
"id": 928,
"name": "ApNortheast2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 79,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-northeast-2"
}
},
{
"id": 929,
"name": "ApSouth1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 80,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-south-1"
}
},
{
"id": 930,
"name": "ApSoutheast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 81,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-southeast-1"
}
},
{
"id": 931,
"name": "ApSoutheast2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 82,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ap-southeast-2"
}
},
{
"id": 932,
"name": "CaCentral1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 83,
"character": 4
}
],
"type": {
"type": "literal",
"value": "ca-central-1"
}
},
{
"id": 933,
"name": "EuCentral1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 84,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-central-1"
}
},
{
"id": 934,
"name": "EuWest1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 85,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-1"
}
},
{
"id": 935,
"name": "EuWest2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 86,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-2"
}
},
{
"id": 936,
"name": "EuWest3",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 87,
"character": 4
}
],
"type": {
"type": "literal",
"value": "eu-west-3"
}
},
{
"id": 937,
"name": "SaEast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 88,
"character": 4
}
],
"type": {
"type": "literal",
"value": "sa-east-1"
}
},
{
"id": 938,
"name": "UsEast1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 89,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-east-1"
}
},
{
"id": 939,
"name": "UsWest1",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 90,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-west-1"
}
},
{
"id": 940,
"name": "UsWest2",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 91,
"character": 4
}
],
"type": {
"type": "literal",
"value": "us-west-2"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [
926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940
]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 76,
"character": 20
}
]
},
{
"id": 3364,
"name": "REALTIME_LISTEN_TYPES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 3365,
"name": "BROADCAST",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 123,
"character": 4
}
],
"type": {
"type": "literal",
"value": "broadcast"
}
},
{
"id": 3367,
"name": "POSTGRES_CHANGES",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 125,
"character": 4
}
],
"type": {
"type": "literal",
"value": "postgres_changes"
}
},
{
"id": 3366,
"name": "PRESENCE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 124,
"character": 4
}
],
"type": {
"type": "literal",
"value": "presence"
}
},
{
"id": 3368,
"name": "SYSTEM",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 126,
"character": 4
}
],
"type": {
"type": "literal",
"value": "system"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [3365, 3367, 3366, 3368]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 122,
"character": 20
}
]
},
{
"id": 3369,
"name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 3370,
"name": "ALL",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 117,
"character": 4
}
],
"type": {
"type": "literal",
"value": "*"
}
},
{
"id": 3373,
"name": "DELETE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 120,
"character": 4
}
],
"type": {
"type": "literal",
"value": "DELETE"
}
},
{
"id": 3371,
"name": "INSERT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 118,
"character": 4
}
],
"type": {
"type": "literal",
"value": "INSERT"
}
},
{
"id": 3372,
"name": "UPDATE",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 119,
"character": 4
}
],
"type": {
"type": "literal",
"value": "UPDATE"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [3370, 3373, 3371, 3372]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 116,
"character": 20
}
]
},
{
"id": 3374,
"name": "REALTIME_PRESENCE_LISTEN_EVENTS",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 3376,
"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": 3377,
"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": 3375,
"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": [3376, 3377, 3375]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts",
"line": 28,
"character": 20
}
]
},
{
"id": 3378,
"name": "REALTIME_SUBSCRIBE_STATES",
"variant": "declaration",
"kind": 8,
"flags": {},
"children": [
{
"id": 3382,
"name": "CHANNEL_ERROR",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 132,
"character": 4
}
],
"type": {
"type": "literal",
"value": "CHANNEL_ERROR"
}
},
{
"id": 3381,
"name": "CLOSED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 131,
"character": 4
}
],
"type": {
"type": "literal",
"value": "CLOSED"
}
},
{
"id": 3379,
"name": "SUBSCRIBED",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 129,
"character": 4
}
],
"type": {
"type": "literal",
"value": "SUBSCRIBED"
}
},
{
"id": 3380,
"name": "TIMED_OUT",
"variant": "declaration",
"kind": 16,
"flags": {},
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 130,
"character": 4
}
],
"type": {
"type": "literal",
"value": "TIMED_OUT"
}
}
],
"groups": [
{
"title": "Enumeration Members",
"children": [3382, 3381, 3379, 3380]
}
],
"sources": [
{
"fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts",
"line": 128,
"character": 20
}
]
},
{
"id": 2550,
"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": 2551,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 45,
"character": 4
}
],
"signatures": [
{
"id": 2552,
"name": "AuthApiError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 45,
"character": 4
}
],
"parameters": [
{
"id": 2553,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2554,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2555,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"target": 2550,
"name": "AuthApiError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2534,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2533,
"name": "AuthError.constructor"
}
},
{
"id": 2559,
"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": 2541,
"name": "AuthError.__isAuthError"
}
},
{
"id": 2557,
"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": 2558,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2538,
"name": "AuthError.code"
}
},
{
"id": 2556,
"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": 44,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"target": 2540,
"name": "AuthError.status"
}
},
{
"id": 2560,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2561,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2562,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2566,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2567,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2564,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2563,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2565,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2566, 2564, 2563, 2565]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2543,
"name": "AuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2542,
"name": "AuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2551]
},
{
"title": "Properties",
"children": [2559, 2557, 2556]
},
{
"title": "Methods",
"children": [2560]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 43,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2532,
"name": "AuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2532,
"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": 2533,
"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": 2534,
"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": 2535,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2536,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2537,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 2532,
"name": "AuthError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
},
{
"id": 2541,
"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": 2538,
"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": 2539,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2540,
"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"
}
]
}
},
{
"id": 2542,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2543,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2544,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2548,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2549,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2546,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2545,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2547,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2548, 2546, 2545, 2547]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [2533]
},
{
"title": "Properties",
"children": [2541, 2538, 2540]
},
{
"title": "Methods",
"children": [2542]
}
],
"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": 2550,
"name": "AuthApiError"
},
{
"type": "reference",
"target": 2568,
"name": "AuthUnknownError"
},
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError"
}
]
},
{
"id": 2655,
"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": 2656,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 139,
"character": 4
}
],
"signatures": [
{
"id": 2657,
"name": "AuthImplicitGrantRedirectError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 139,
"character": 4
}
],
"parameters": [
{
"id": 2658,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2659,
"name": "details",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2660,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2662,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 141,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2661,
"name": "error",
"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": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2662, 2661]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 139,
"character": 43
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"target": 2655,
"name": "AuthImplicitGrantRedirectError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2683,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2681,
"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": 2682,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2663,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 135,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2664,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2666,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 137,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2665,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 136,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2666, 2665]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 135,
"character": 13
}
]
}
}
]
}
},
{
"id": 2679,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2680,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2667,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 143,
"character": 4
}
],
"signatures": [
{
"id": 2668,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 143,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2669,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2673,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 147,
"character": 8
}
],
"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": 2674,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2675,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 148,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2676,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2678,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 150,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2677,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 149,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2678, 2677]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 148,
"character": 17
}
]
}
}
]
}
},
{
"id": 2671,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 145,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2670,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 144,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2672,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 146,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2673, 2675, 2671, 2670, 2672]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 143,
"character": 14
}
]
}
},
"overwrites": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"overwrites": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2656]
},
{
"title": "Properties",
"children": [2683, 2681, 2663, 2679, 2680]
},
{
"title": "Methods",
"children": [2667]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 134,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2638,
"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": 2639,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 119,
"character": 4
}
],
"signatures": [
{
"id": 2640,
"name": "AuthInvalidCredentialsError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 119,
"character": 4
}
],
"parameters": [
{
"id": 2641,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 2638,
"name": "AuthInvalidCredentialsError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2646,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2644,
"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": 2645,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2642,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2643,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2647,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2648,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2649,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2653,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2654,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2651,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2650,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2652,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2653, 2651, 2650, 2652]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2639]
},
{
"title": "Properties",
"children": [2646, 2644, 2642, 2643]
},
{
"title": "Methods",
"children": [2647]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 118,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2768,
"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": 2769,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 256,
"character": 4
}
],
"signatures": [
{
"id": 2770,
"name": "AuthInvalidJwtError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 256,
"character": 4
}
],
"parameters": [
{
"id": 2771,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"target": 2768,
"name": "AuthInvalidJwtError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2776,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2774,
"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": 2775,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2772,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2773,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2777,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2778,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2779,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2783,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2784,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2781,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2780,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2782,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2783, 2781, 2780, 2782]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2769]
},
{
"title": "Properties",
"children": [2776, 2774, 2772, 2773]
},
{
"title": "Methods",
"children": [2777]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 255,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2622,
"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": 2623,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 106,
"character": 4
}
],
"signatures": [
{
"id": 2624,
"name": "AuthInvalidTokenResponseError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 106,
"character": 4
}
],
"type": {
"type": "reference",
"target": 2622,
"name": "AuthInvalidTokenResponseError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2629,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2627,
"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": 2628,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2625,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2626,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2630,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2631,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2632,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2636,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2637,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2634,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2633,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2635,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2636, 2634, 2633, 2635]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2623]
},
{
"title": "Properties",
"children": [2629, 2627, 2625, 2626]
},
{
"title": "Methods",
"children": [2630]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 105,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2713,
"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": 2714,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 198,
"character": 4
}
],
"signatures": [
{
"id": 2715,
"name": "AuthPKCECodeVerifierMissingError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 198,
"character": 4
}
],
"type": {
"type": "reference",
"target": 2713,
"name": "AuthPKCECodeVerifierMissingError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2720,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2718,
"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": 2719,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2716,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2717,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2721,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2722,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2723,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2727,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2728,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2725,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2724,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2726,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2727, 2725, 2724, 2726]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2714]
},
{
"title": "Properties",
"children": [2720, 2718, 2716, 2717]
},
{
"title": "Methods",
"children": [2721]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 197,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2684,
"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": 2685,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 170,
"character": 4
}
],
"signatures": [
{
"id": 2686,
"name": "AuthPKCEGrantCodeExchangeError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 170,
"character": 4
}
],
"parameters": [
{
"id": 2687,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2688,
"name": "details",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2689,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2691,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 172,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2690,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 171,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2691, 2690]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 170,
"character": 43
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"target": 2684,
"name": "AuthPKCEGrantCodeExchangeError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2712,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2710,
"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": 2711,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2692,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 166,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2693,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2695,
"name": "code",
"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": 2694,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 167,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2695, 2694]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 166,
"character": 13
}
]
}
}
]
}
},
{
"id": 2708,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2709,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2696,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 174,
"character": 4
}
],
"signatures": [
{
"id": 2697,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 174,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2698,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2702,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 178,
"character": 8
}
],
"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": 2703,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2704,
"name": "details",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 179,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 2705,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2707,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 181,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2706,
"name": "error",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 180,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [2707, 2706]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 179,
"character": 17
}
]
}
}
]
}
},
{
"id": 2700,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 176,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2699,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 175,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2701,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 177,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2702, 2704, 2700, 2699, 2701]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 174,
"character": 14
}
]
}
},
"overwrites": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"overwrites": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2685]
},
{
"title": "Properties",
"children": [2712, 2710, 2692, 2708, 2709]
},
{
"title": "Methods",
"children": [2696]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 165,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2729,
"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": 2730,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 212,
"character": 4
}
],
"signatures": [
{
"id": 2731,
"name": "AuthRetryableFetchError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 212,
"character": 4
}
],
"parameters": [
{
"id": 2732,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2733,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"target": 2729,
"name": "AuthRetryableFetchError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2738,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2736,
"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": 2737,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2734,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2735,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2739,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2740,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2741,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2745,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2746,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2743,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2742,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2744,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2745, 2743, 2742, 2744]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2730]
},
{
"title": "Properties",
"children": [2738, 2736, 2734, 2735]
},
{
"title": "Methods",
"children": [2739]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 211,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2606,
"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": 2607,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 92,
"character": 4
}
],
"signatures": [
{
"id": 2608,
"name": "AuthSessionMissingError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 92,
"character": 4
}
],
"type": {
"type": "reference",
"target": 2606,
"name": "AuthSessionMissingError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2613,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2611,
"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": 2612,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2609,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2610,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2614,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2615,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2616,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2620,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2621,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2618,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2617,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2619,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2620, 2618, 2617, 2619]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2607]
},
{
"title": "Properties",
"children": [2613, 2611, 2609, 2610]
},
{
"title": "Methods",
"children": [2614]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 91,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2568,
"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": 2569,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 64,
"character": 4
}
],
"signatures": [
{
"id": 2570,
"name": "AuthUnknownError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 64,
"character": 4
}
],
"parameters": [
{
"id": 2571,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2572,
"name": "originalError",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"target": 2568,
"name": "AuthUnknownError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2534,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2533,
"name": "AuthError.constructor"
}
},
{
"id": 2577,
"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": 2541,
"name": "AuthError.__isAuthError"
}
},
{
"id": 2574,
"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": 2575,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2538,
"name": "AuthError.code"
}
},
{
"id": 2573,
"name": "originalError",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 63,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "unknown"
}
},
{
"id": 2576,
"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": 2540,
"name": "AuthError.status"
}
},
{
"id": 2578,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2579,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2580,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2584,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2585,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2582,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2581,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2583,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2584, 2582, 2581, 2583]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2543,
"name": "AuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2542,
"name": "AuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2569]
},
{
"title": "Properties",
"children": [2577, 2574, 2573, 2576]
},
{
"title": "Methods",
"children": [2578]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 62,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2532,
"name": "AuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2747,
"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": 2748,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 235,
"character": 4
}
],
"signatures": [
{
"id": 2749,
"name": "AuthWeakPasswordError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 235,
"character": 4
}
],
"parameters": [
{
"id": 2750,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2751,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2752,
"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": 2747,
"name": "AuthWeakPasswordError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2588,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2587,
"name": "CustomAuthError.constructor"
}
},
{
"id": 2767,
"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": 2597,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 2765,
"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": 2766,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2595,
"name": "CustomAuthError.code"
}
},
{
"id": 2763,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"target": 2593,
"name": "CustomAuthError.name"
}
},
{
"id": 2753,
"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": 234,
"character": 4
}
],
"type": {
"type": "array",
"elementType": {
"type": "union",
"types": [
{
"type": "literal",
"value": "length"
},
{
"type": "literal",
"value": "characters"
},
{
"type": "literal",
"value": "pwned"
}
]
}
}
},
{
"id": 2764,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"target": 2594,
"name": "CustomAuthError.status"
}
},
{
"id": 2754,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 236,
"character": 4
}
],
"signatures": [
{
"id": 2755,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 236,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2756,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2760,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 240,
"character": 8
}
],
"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": 2761,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2758,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 238,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2757,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 237,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2762,
"name": "reasons",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 241,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "union",
"types": [
{
"type": "literal",
"value": "length"
},
{
"type": "literal",
"value": "characters"
},
{
"type": "literal",
"value": "pwned"
}
]
}
}
},
{
"id": 2759,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 239,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2760, 2758, 2757, 2762, 2759]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 236,
"character": 14
}
]
}
},
"overwrites": {
"type": "reference",
"target": 2599,
"name": "CustomAuthError.toJSON"
}
}
],
"overwrites": {
"type": "reference",
"target": 2598,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2748]
},
{
"title": "Properties",
"children": [2767, 2765, 2763, 2753, 2764]
},
{
"title": "Methods",
"children": [2754]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 230,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
}
]
},
{
"id": 2586,
"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": 2587,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 79,
"character": 4
}
],
"signatures": [
{
"id": 2588,
"name": "CustomAuthError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 79,
"character": 4
}
],
"parameters": [
{
"id": 2589,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2590,
"name": "name",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2591,
"name": "status",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 2592,
"name": "code",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"target": 2586,
"name": "CustomAuthError",
"package": "@supabase/auth-js"
},
"overwrites": {
"type": "reference",
"target": 2534,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 2533,
"name": "AuthError.constructor"
}
},
{
"id": 2597,
"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": 2541,
"name": "AuthError.__isAuthError"
}
},
{
"id": 2595,
"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": 2596,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
},
"inheritedFrom": {
"type": "reference",
"target": 2538,
"name": "AuthError.code"
}
},
{
"id": 2593,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "AuthError.name"
}
},
{
"id": 2594,
"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": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"target": 2540,
"name": "AuthError.status"
}
},
{
"id": 2598,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"signatures": [
{
"id": 2599,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 2600,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 2604,
"name": "code",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 29,
"character": 8
}
],
"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": 2605,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {}
}
}
]
}
]
}
},
{
"id": 2602,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2601,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 26,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2603,
"name": "status",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"children": [2604, 2602, 2601, 2603]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 25,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 2543,
"name": "AuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 2542,
"name": "AuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [2587]
},
{
"title": "Properties",
"children": [2597, 2595, 2593, 2594]
},
{
"title": "Methods",
"children": [2598]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts",
"line": 76,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 2532,
"name": "AuthError",
"package": "@supabase/auth-js"
}
],
"extendedBy": [
{
"type": "reference",
"target": 2606,
"name": "AuthSessionMissingError"
},
{
"type": "reference",
"target": 2622,
"name": "AuthInvalidTokenResponseError"
},
{
"type": "reference",
"target": 2638,
"name": "AuthInvalidCredentialsError"
},
{
"type": "reference",
"target": 2655,
"name": "AuthImplicitGrantRedirectError"
},
{
"type": "reference",
"target": 2684,
"name": "AuthPKCEGrantCodeExchangeError"
},
{
"type": "reference",
"target": 2713,
"name": "AuthPKCECodeVerifierMissingError"
},
{
"type": "reference",
"target": 2729,
"name": "AuthRetryableFetchError"
},
{
"type": "reference",
"target": 2747,
"name": "AuthWeakPasswordError"
},
{
"type": "reference",
"target": 2768,
"name": "AuthInvalidJwtError"
}
]
},
{
"id": 912,
"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": 913,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 30,
"character": 4
}
],
"signatures": [
{
"id": 914,
"name": "FunctionsError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 30,
"character": 4
}
],
"parameters": [
{
"id": 915,
"name": "message",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 916,
"name": "name",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 917,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 912,
"name": "FunctionsError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": -1,
"name": "Error.constructor"
}
},
{
"id": 918,
"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"
}
},
{
"id": 919,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"signatures": [
{
"id": 920,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 921,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 924,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 34,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 923,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 922,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [924, 923, 922]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 14
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [913]
},
{
"title": "Properties",
"children": [918]
},
{
"title": "Methods",
"children": [919]
}
],
"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": 879,
"name": "FunctionsHttpError"
},
{
"type": "reference",
"target": 890,
"name": "FunctionsFetchError"
},
{
"type": "reference",
"target": 901,
"name": "FunctionsRelayError"
}
]
},
{
"id": 890,
"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": 891,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 48,
"character": 4
}
],
"signatures": [
{
"id": 892,
"name": "FunctionsFetchError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 48,
"character": 4
}
],
"parameters": [
{
"id": 893,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 890,
"name": "FunctionsFetchError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 914,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 913,
"name": "FunctionsError.constructor"
}
},
{
"id": 894,
"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": 918,
"name": "FunctionsError.context"
}
},
{
"id": 895,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"signatures": [
{
"id": 896,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 897,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 900,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 34,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 899,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 898,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [900, 899, 898]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 920,
"name": "FunctionsError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 919,
"name": "FunctionsError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [891]
},
{
"title": "Properties",
"children": [894]
},
{
"title": "Methods",
"children": [895]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 47,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 912,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 879,
"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": 880,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 74,
"character": 4
}
],
"signatures": [
{
"id": 881,
"name": "FunctionsHttpError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 74,
"character": 4
}
],
"parameters": [
{
"id": 882,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 879,
"name": "FunctionsHttpError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 914,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 913,
"name": "FunctionsError.constructor"
}
},
{
"id": 883,
"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": 918,
"name": "FunctionsError.context"
}
},
{
"id": 884,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"signatures": [
{
"id": 885,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 886,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 889,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 34,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 888,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 887,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [889, 888, 887]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 920,
"name": "FunctionsError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 919,
"name": "FunctionsError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [880]
},
{
"title": "Properties",
"children": [883]
},
{
"title": "Methods",
"children": [884]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 73,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 912,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 901,
"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": 902,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 61,
"character": 4
}
],
"signatures": [
{
"id": 903,
"name": "FunctionsRelayError",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 61,
"character": 4
}
],
"parameters": [
{
"id": 904,
"name": "context",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 901,
"name": "FunctionsRelayError",
"package": "@supabase/functions-js"
},
"overwrites": {
"type": "reference",
"target": 914,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": 913,
"name": "FunctionsError.constructor"
}
},
{
"id": 905,
"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": 918,
"name": "FunctionsError.context"
}
},
{
"id": 906,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"signatures": [
{
"id": 907,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 908,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 911,
"name": "context",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 34,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 910,
"name": "message",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 909,
"name": "name",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [911, 910, 909]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 31,
"character": 14
}
]
}
},
"inheritedFrom": {
"type": "reference",
"target": 920,
"name": "FunctionsError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": 919,
"name": "FunctionsError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [902]
},
{
"title": "Properties",
"children": [905]
},
{
"title": "Methods",
"children": [906]
}
],
"sources": [
{
"fileName": "packages/core/functions-js/dist/module/types.d.ts",
"line": 60,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": 912,
"name": "FunctionsError",
"package": "@supabase/functions-js"
}
]
},
{
"id": 1119,
"name": "GoTrueAdminApi",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 1120,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 47,
"character": 4
}
],
"signatures": [
{
"id": 1121,
"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",
"name": "Using supabase-js (recommended)",
"content": [
{
"kind": "code",
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```"
}
]
},
{
"tag": "@example",
"name": "Standalone import for bundle-sensitive environments",
"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_SECRET_KEY}` },\n})\n```"
}
]
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 47,
"character": 4
}
],
"parameters": [
{
"id": 1122,
"name": "__namedParameters",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1123,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 1137,
"name": "experimental",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 53,
"character": 8
}
],
"type": {
"type": "reference",
"target": 1624,
"name": "ExperimentalFeatureFlags",
"package": "@supabase/auth-js"
}
},
{
"id": 1129,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 52,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1130,
"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": 1131,
"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": 1132,
"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": 1133,
"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": 1134,
"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": 1135,
"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": 1136,
"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": 1125,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 49,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1126,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 49,
"character": 18
}
],
"indexSignatures": [
{
"id": 1127,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 50,
"character": 12
}
],
"parameters": [
{
"id": 1128,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 1124,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 48,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"children": [1137, 1129, 1125, 1124]
}
],
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 47,
"character": 56
}
]
}
}
}
],
"type": {
"type": "reference",
"target": 1119,
"name": "GoTrueAdminApi",
"package": "@supabase/auth-js",
"qualifiedName": "default"
}
}
]
},
{
"id": 1140,
"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": 2335,
"name": "GoTrueAdminCustomProvidersApi",
"package": "@supabase/auth-js"
}
},
{
"id": 1155,
"name": "experimental",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 25,
"character": 14
}
],
"type": {
"type": "reference",
"target": 1624,
"name": "ExperimentalFeatureFlags",
"package": "@supabase/auth-js"
}
},
{
"id": 1147,
"name": "fetch",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 24,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1148,
"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": 1149,
"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": 1150,
"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": 1151,
"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": 1152,
"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": 1153,
"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": 1154,
"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": 1143,
"name": "headers",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 21,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 1144,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 21,
"character": 23
}
],
"indexSignatures": [
{
"id": 1145,
"name": "__index",
"variant": "signature",
"kind": 8192,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 22,
"character": 8
}
],
"parameters": [
{
"id": 1146,
"name": "key",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 1138,
"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": 2088,
"name": "GoTrueAdminMFAApi",
"package": "@supabase/auth-js"
}
},
{
"id": 1139,
"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": 2220,
"name": "GoTrueAdminOAuthApi",
"package": "@supabase/auth-js"
}
},
{
"id": 1141,
"name": "passkey",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Contains all passkey administration methods.\n\nRequires "
},
{
"kind": "code",
"text": "`auth.experimental.passkey: true`"
},
{
"kind": "text",
"text": "; otherwise all methods throw."
}
]
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 19,
"character": 4
}
],
"type": {
"type": "reference",
"target": 2504,
"name": "GoTrueAdminPasskeyApi",
"package": "@supabase/auth-js"
}
},
{
"id": 1142,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 20,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1173,
"name": "createUser",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 335,
"character": 4
}
],
"signatures": [
{
"id": 1174,
"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": "@subcategory",
"content": [
{
"kind": "text",
"text": "Auth Admin"
}
]
},
{
"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": 335,
"character": 4
}
],
"parameters": [
{
"id": 1175,
"name": "attributes",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 1742,
"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": 1693,
"name": "UserResponse",
"package": "@supabase/auth-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 1197,
"name": "deleteUser",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 613,
"character": 4
}
],
"signatures": [
{
"id": 1198,
"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": "@subcategory",
"content": [
{
"kind": "text",
"text": "Auth Admin"
}
]
},
{
"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": 613,
"character": 4
}
],
"parameters": [
{
"id": 1199,
"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": 1200,
"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": 1693,
"name": "UserResponse",
"package": "@supabase/auth-js"
}
],
"name": "Promise",
"package": "typescript"
}
}
]
},
{
"id": 1170,
"name": "generateLink",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts",
"line": 254,
"character": 4
}
],
"signatures": [
{
"id": 1171,
"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": "@subcategory",
"content": [
{
"kind": "text",
"text": "Auth Admin"
}
]
},
{
"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