Files
supabase/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json
2024-01-03 18:54:23 +01:00

19129 lines
404 KiB
JSON

{
"id": 0,
"name": "@supabase/gotrue-js",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 1017,
"name": "AuthApiError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1018,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 19,
"character": 2
}
],
"signatures": [
{
"id": 1019,
"name": "new AuthApiError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1020,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1021,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 1017,
"name": "AuthApiError"
},
"overwrites": {
"type": "reference",
"id": 1012,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1011,
"name": "AuthError.constructor"
}
},
{
"id": 1022,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"id": 1015,
"name": "AuthError.status"
}
},
{
"id": 1023,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 25,
"character": 2
}
],
"signatures": [
{
"id": 1024,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1025,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1027,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 28,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1026,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 27,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1028,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 29,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1027,
1026,
1028
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1018
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1022
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1023
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 16,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1010,
"name": "AuthError"
}
]
},
{
"id": 1010,
"name": "AuthError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1011,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 5,
"character": 2
}
],
"signatures": [
{
"id": 1012,
"name": "new AuthError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1013,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1014,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
},
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
},
{
"id": 1015,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1011
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1015
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 1,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"qualifiedName": "Error",
"package": "typescript",
"name": "Error"
}
],
"extendedBy": [
{
"type": "reference",
"id": 1017,
"name": "AuthApiError"
},
{
"type": "reference",
"id": 1030,
"name": "AuthUnknownError"
},
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1090,
"name": "AuthImplicitGrantRedirectError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1091,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 86,
"character": 2
}
],
"signatures": [
{
"id": 1092,
"name": "new AuthImplicitGrantRedirectError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1093,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1094,
"name": "details",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1095,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1097,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 86,
"character": 57
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1096,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 86,
"character": 42
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1097,
1096
]
}
]
}
}
]
},
"defaultValue": "null"
}
],
"type": {
"type": "reference",
"id": 1090,
"name": "AuthImplicitGrantRedirectError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1098,
"name": "details",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 85,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1099,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1101,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 85,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1100,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 85,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1101,
1100
]
}
]
}
}
]
},
"defaultValue": "null"
},
{
"id": 1112,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1113,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1102,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 91,
"character": 2
}
],
"signatures": [
{
"id": 1103,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1104,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1108,
"name": "details",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 96,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1109,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1111,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 85,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1110,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 85,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1111,
1110
]
}
]
}
}
]
},
"defaultValue": "..."
},
{
"id": 1106,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 94,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1105,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 93,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1107,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 95,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1108,
1106,
1105,
1107
]
}
]
}
},
"overwrites": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"overwrites": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1091
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1098,
1112,
1113
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1102
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 84,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1077,
"name": "AuthInvalidCredentialsError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1078,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 79,
"character": 2
}
],
"signatures": [
{
"id": 1079,
"name": "new AuthInvalidCredentialsError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1080,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 1077,
"name": "AuthInvalidCredentialsError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1081,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1082,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1083,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1084,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1085,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1087,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1086,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1088,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1087,
1086,
1088
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1078
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1081,
1082
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1083
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 78,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1065,
"name": "AuthInvalidTokenResponseError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1066,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 73,
"character": 2
}
],
"signatures": [
{
"id": 1067,
"name": "new AuthInvalidTokenResponseError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"type": {
"type": "reference",
"id": 1065,
"name": "AuthInvalidTokenResponseError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1068,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1069,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1070,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1071,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1072,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1074,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1073,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1075,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1074,
1073,
1075
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1066
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1068,
1069
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1070
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 72,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1115,
"name": "AuthPKCEGrantCodeExchangeError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1116,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 103,
"character": 2
}
],
"signatures": [
{
"id": 1117,
"name": "new AuthPKCEGrantCodeExchangeError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1118,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1119,
"name": "details",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1120,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1122,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 103,
"character": 57
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1121,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 103,
"character": 42
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1122,
1121
]
}
]
}
}
]
},
"defaultValue": "null"
}
],
"type": {
"type": "reference",
"id": 1115,
"name": "AuthPKCEGrantCodeExchangeError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1123,
"name": "details",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 102,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1124,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1126,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 102,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1125,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 102,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1126,
1125
]
}
]
}
}
]
},
"defaultValue": "null"
},
{
"id": 1137,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1138,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1127,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 108,
"character": 2
}
],
"signatures": [
{
"id": 1128,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1129,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1133,
"name": "details",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 113,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 1134,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1136,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 102,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1135,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 102,
"character": 13
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1136,
1135
]
}
]
}
}
]
},
"defaultValue": "..."
},
{
"id": 1131,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 111,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1130,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 110,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1132,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 112,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1133,
1131,
1130,
1132
]
}
]
}
},
"overwrites": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"overwrites": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1116
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1123,
1137,
1138
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1127
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 101,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1140,
"name": "AuthRetryableFetchError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1141,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 119,
"character": 2
}
],
"signatures": [
{
"id": 1142,
"name": "new AuthRetryableFetchError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1143,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1144,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 1140,
"name": "AuthRetryableFetchError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1145,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1146,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1147,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1148,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1149,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1151,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1150,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1152,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1151,
1150,
1152
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1141
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1145,
1146
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1147
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 118,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1053,
"name": "AuthSessionMissingError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1054,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 67,
"character": 2
}
],
"signatures": [
{
"id": 1055,
"name": "new AuthSessionMissingError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"type": {
"type": "reference",
"id": 1053,
"name": "AuthSessionMissingError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1056,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1057,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1058,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1059,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1060,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1062,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1061,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1063,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1062,
1061,
1063
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1054
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1056,
1057
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1058
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 66,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1030,
"name": "AuthUnknownError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1031,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 41,
"character": 2
}
],
"signatures": [
{
"id": 1032,
"name": "new AuthUnknownError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1033,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1034,
"name": "originalError",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"id": 1030,
"name": "AuthUnknownError"
},
"overwrites": {
"type": "reference",
"id": 1012,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1011,
"name": "AuthError.constructor"
}
},
{
"id": 1035,
"name": "originalError",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 39,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "unknown"
}
},
{
"id": 1036,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 1015,
"name": "AuthError.status"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1031
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1035,
1036
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 38,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1010,
"name": "AuthError"
}
]
},
{
"id": 1154,
"name": "AuthWeakPasswordError",
"kind": 128,
"kindString": "Class",
"flags": {},
"comment": {
"shortText": "This error is thrown on certain methods when the password used is deemed\nweak. Inspect the reasons to identify what password strength rules are\ninadequate."
},
"children": [
{
"id": 1155,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 139,
"character": 2
}
],
"signatures": [
{
"id": 1156,
"name": "new AuthWeakPasswordError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1157,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1158,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1159,
"name": "reasons",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"type": {
"type": "reference",
"id": 1154,
"name": "AuthWeakPasswordError"
},
"overwrites": {
"type": "reference",
"id": 1040,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1039,
"name": "CustomAuthError.constructor"
}
},
{
"id": 1161,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 1044,
"name": "CustomAuthError.name"
}
},
{
"id": 1160,
"name": "reasons",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Reasons why the password is deemed weak."
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 137,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 1162,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 1045,
"name": "CustomAuthError.status"
}
},
{
"id": 1163,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1164,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1165,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1167,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1166,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1168,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1167,
1166,
1168
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 1047,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 1046,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1155
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1161,
1160,
1162
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1163
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 133,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
}
]
},
{
"id": 1038,
"name": "CustomAuthError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 1039,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 51,
"character": 2
}
],
"signatures": [
{
"id": 1040,
"name": "new CustomAuthError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 1041,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1042,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1043,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 1038,
"name": "CustomAuthError"
},
"overwrites": {
"type": "reference",
"id": 1012,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 1011,
"name": "AuthError.constructor"
}
},
{
"id": 1044,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"overwrites": {
"type": "reference",
"name": "AuthError.name"
}
},
{
"id": 1045,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"overwrites": {
"type": "reference",
"id": 1015,
"name": "AuthError.status"
}
},
{
"id": 1046,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 57,
"character": 2
}
],
"signatures": [
{
"id": 1047,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 1048,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 1050,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1049,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 1051,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
1050,
1049,
1051
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
1039
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
1044,
1045
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
1046
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 48,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 1010,
"name": "AuthError"
}
],
"extendedBy": [
{
"type": "reference",
"id": 1053,
"name": "AuthSessionMissingError"
},
{
"type": "reference",
"id": 1065,
"name": "AuthInvalidTokenResponseError"
},
{
"type": "reference",
"id": 1077,
"name": "AuthInvalidCredentialsError"
},
{
"type": "reference",
"id": 1090,
"name": "AuthImplicitGrantRedirectError"
},
{
"type": "reference",
"id": 1115,
"name": "AuthPKCEGrantCodeExchangeError"
},
{
"type": "reference",
"id": 1140,
"name": "AuthRetryableFetchError"
},
{
"type": "reference",
"id": 1154,
"name": "AuthWeakPasswordError"
}
]
},
{
"id": 1,
"name": "GoTrueAdminApi",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 35,
"character": 2
}
],
"signatures": [
{
"id": 3,
"name": "new GoTrueAdminApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 4,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 5,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 11,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 44,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 12,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 13,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 14,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 15,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 7,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 41,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 8,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 9,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 10,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 6,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 40,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
11,
7,
6
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
}
]
},
{
"id": 16,
"name": "mfa",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Contains all MFA administration methods."
},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 27,
"character": 2
}
],
"type": {
"type": "reference",
"id": 966,
"name": "GoTrueAdminMFAApi"
}
},
{
"id": 44,
"name": "createUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 152,
"character": 8
}
],
"signatures": [
{
"id": 45,
"name": "createUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser."
},
"parameters": [
{
"id": 46,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 645,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 68,
"name": "deleteUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 268,
"character": 8
}
],
"signatures": [
{
"id": 69,
"name": "deleteUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Delete a user. Requires a `service_role` key."
},
"parameters": [
{
"id": 70,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user id you want to remove."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 71,
"name": "shouldSoftDelete",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "If true, then the user will be soft-deleted from the auth schema.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 41,
"name": "generateLink",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 118,
"character": 8
}
],
"signatures": [
{
"id": 42,
"name": "generateLink",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates email links and OTPs to be sent via a custom email provider."
},
"parameters": [
{
"id": 43,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 810,
"name": "GenerateLinkParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 811,
"name": "GenerateLinkResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 61,
"name": "getUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 221,
"character": 8
}
],
"signatures": [
{
"id": 62,
"name": "getUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Get user by id."
},
"parameters": [
{
"id": 63,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 34,
"name": "inviteUserByEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 85,
"character": 8
}
],
"signatures": [
{
"id": 35,
"name": "inviteUserByEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends an invite link to an email address."
},
"parameters": [
{
"id": 36,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 37,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Additional options to be included when inviting.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 38,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 39,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column."
},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 89,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 40,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL."
},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 92,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
39,
40
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 47,
"name": "listUsers",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 174,
"character": 8
}
],
"signatures": [
{
"id": 48,
"name": "listUsers",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Get a list of users.",
"text": "This function should only be called on a server. Never expose your `service_role` key in the browser."
},
"parameters": [
{
"id": 49,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An object which supports `page` and `perPage` as numbers, to alter the paginated results.\n"
},
"type": {
"type": "reference",
"id": 991,
"name": "PageParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 50,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 51,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 177,
"character": 8
}
],
"type": {
"type": "intersection",
"types": [
{
"type": "reflection",
"declaration": {
"id": 52,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 54,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 177,
"character": 31
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 53,
"name": "users",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 177,
"character": 16
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 616,
"name": "User"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
54,
53
]
}
]
}
},
{
"type": "reference",
"id": 984,
"name": "Pagination"
}
]
}
},
{
"id": 55,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 177,
"character": 59
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
51,
55
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 56,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 57,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 178,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 58,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 59,
"name": "users",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 178,
"character": 16
}
],
"type": {
"type": "tuple"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
59
]
}
]
}
}
},
{
"id": 60,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 178,
"character": 29
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
57,
60
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 27,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 60,
"character": 8
}
],
"signatures": [
{
"id": 28,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 29,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 30,
"name": "scope",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The logout sope.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "global"
},
{
"type": "literal",
"value": "local"
},
{
"type": "literal",
"value": "others"
}
]
},
"defaultValue": "'global'"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 32,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 63,
"character": 15
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 33,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 63,
"character": 27
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 1010,
"name": "AuthError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
32,
33
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 64,
"name": "updateUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 243,
"character": 8
}
],
"signatures": [
{
"id": 65,
"name": "updateUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 66,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 67,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"type": {
"type": "reference",
"id": 645,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
16
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
44,
68,
41,
61,
34,
47,
27,
64
]
}
],
"sources": [
{
"fileName": "src/GoTrueAdminApi.ts",
"line": 25,
"character": 21
}
]
},
{
"id": 78,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 80,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 164,
"character": 2
}
],
"signatures": [
{
"id": 81,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 82,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 484,
"name": "GoTrueClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 78,
"name": "default"
}
}
]
},
{
"id": 84,
"name": "admin",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 116,
"character": 2
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
},
{
"id": 85,
"name": "mfa",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Namespace for the MFA methods."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 120,
"character": 2
}
],
"type": {
"type": "reference",
"id": 921,
"name": "GoTrueMFAApi"
}
},
{
"id": 139,
"name": "exchangeCodeForSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 503,
"character": 8
}
],
"signatures": [
{
"id": 140,
"name": "exchangeCodeForSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow."
},
"parameters": [
{
"id": 141,
"name": "authCode",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 532,
"name": "AuthTokenResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 178,
"name": "getSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 849,
"character": 8
}
],
"signatures": [
{
"id": 179,
"name": "getSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 180,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 181,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 940,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 182,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 183,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 941,
"character": 14
}
],
"type": {
"type": "reference",
"id": 578,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
183
]
}
]
}
}
},
{
"id": 184,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 943,
"character": 12
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
181,
184
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 186,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 946,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 187,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 188,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 947,
"character": 14
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
188
]
}
]
}
}
},
{
"id": 189,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 949,
"character": 12
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
186,
189
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 190,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 191,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 952,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 192,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 193,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 953,
"character": 14
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
193
]
}
]
}
}
},
{
"id": 194,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 955,
"character": 12
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
191,
194
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 241,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1052,
"character": 8
}
],
"signatures": [
{
"id": 242,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the current user details if there is an existing session."
},
"parameters": [
{
"id": 243,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 345,
"name": "getUserIdentities",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1591,
"character": 8
}
],
"signatures": [
{
"id": 346,
"name": "getUserIdentities",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets all the identities linked to a user."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 347,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 348,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1593,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 349,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 350,
"name": "identities",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1594,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 590,
"name": "UserIdentity"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
350
]
}
]
}
}
},
{
"id": 351,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1596,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
348,
351
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 352,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 353,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1598,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 354,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1598,
"character": 20
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
353,
354
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 126,
"name": "initialize",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 259,
"character": 8
}
],
"signatures": [
{
"id": 127,
"name": "initialize",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 974,
"name": "InitializeResult"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 355,
"name": "linkIdentity",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1615,
"character": 8
}
],
"signatures": [
{
"id": 356,
"name": "linkIdentity",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow."
},
"parameters": [
{
"id": 357,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 715,
"name": "SignInWithOAuthCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 545,
"name": "OAuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 317,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1487,
"character": 2
}
],
"signatures": [
{
"id": 318,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Receive a notification every time an auth event happens."
},
"parameters": [
{
"id": 319,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A callback function to be invoked when an auth event happens.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 320,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 321,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 322,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 474,
"name": "AuthChangeEvent"
}
},
{
"id": 323,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 578,
"name": "Session"
}
]
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "void"
},
{
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
]
}
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 324,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 325,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1490,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 326,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 327,
"name": "subscription",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1490,
"character": 12
}
],
"type": {
"type": "reference",
"id": 656,
"name": "Subscription"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
327
]
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
325
]
}
]
}
}
}
]
},
{
"id": 171,
"name": "reauthenticate",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 768,
"character": 8
}
],
"signatures": [
{
"id": 172,
"name": "reauthenticate",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 504,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 278,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1253,
"character": 8
}
],
"signatures": [
{
"id": 279,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown."
},
"parameters": [
{
"id": 280,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The current session. If passed in, it must contain a refresh token.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 281,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 282,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1253,
"character": 42
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
282
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 504,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 175,
"name": "resend",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 803,
"character": 8
}
],
"signatures": [
{
"id": 176,
"name": "resend",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP."
},
"parameters": [
{
"id": 177,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 758,
"name": "ResendParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 517,
"name": "AuthOtpResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 331,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1543,
"character": 8
}
],
"signatures": [
{
"id": 332,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a password reset request to an email address. This method supports the PKCE flow."
},
"parameters": [
{
"id": 333,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 334,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 335,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 337,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site.\n"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1547,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 336,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL to send the user to after they click the password reset link."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1546,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
337,
336
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 338,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 339,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1551,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 340,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
},
{
"id": 341,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1552,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
339,
341
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 342,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 343,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1554,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 344,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1554,
"character": 20
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
343,
344
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 266,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1178,
"character": 8
}
],
"signatures": [
{
"id": 267,
"name": "setSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown."
},
"parameters": [
{
"id": 268,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The current session that minimally contains an access token and refresh token.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 269,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 270,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1179,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 271,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1180,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
270,
271
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 504,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 159,
"name": "signInWithIdToken",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 554,
"character": 8
}
],
"signatures": [
{
"id": 160,
"name": "signInWithIdToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured."
},
"parameters": [
{
"id": 161,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 727,
"name": "SignInWithIdTokenCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 532,
"name": "AuthTokenResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 136,
"name": "signInWithOAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 489,
"character": 8
}
],
"signatures": [
{
"id": 137,
"name": "signInWithOAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow."
},
"parameters": [
{
"id": 138,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 715,
"name": "SignInWithOAuthCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 545,
"name": "OAuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 162,
"name": "signInWithOtp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 611,
"character": 8
}
],
"signatures": [
{
"id": 163,
"name": "signInWithOtp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in a user using magiclink or a one-time password (OTP).",
"text": "If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed.\n"
},
"parameters": [
{
"id": 164,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 697,
"name": "SignInWithPasswordlessCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 517,
"name": "AuthOtpResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 133,
"name": "signInWithPassword",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 433,
"character": 8
}
],
"signatures": [
{
"id": 134,
"name": "signInWithPassword",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user with an email and password or phone and password.",
"text": "Be aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login.\n"
},
"parameters": [
{
"id": 135,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 683,
"name": "SignInWithPasswordCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 532,
"name": "AuthTokenResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 168,
"name": "signInWithSSO",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 729,
"character": 8
}
],
"signatures": [
{
"id": 169,
"name": "signInWithSSO",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.",
"text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n"
},
"parameters": [
{
"id": 170,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 772,
"name": "SignInWithSSO"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 558,
"name": "SSOResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 307,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1447,
"character": 8
}
],
"signatures": [
{
"id": 308,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.",
"text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using `others` scope, no `SIGNED_OUT` event is fired!\n"
},
"parameters": [
{
"id": 309,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 995,
"name": "SignOut"
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 310,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 311,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1447,
"character": 67
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 1010,
"name": "AuthError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
311
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 130,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 354,
"character": 8
}
],
"signatures": [
{
"id": 131,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user.",
"text": "Be aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.\n",
"returns": "A logged-in session if the server has \"autoconfirm\" ON"
},
"parameters": [
{
"id": 132,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 666,
"name": "SignUpWithPasswordCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 504,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 413,
"name": "startAutoRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 2023,
"character": 8
}
],
"signatures": [
{
"id": 414,
"name": "startAutoRefresh",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.",
"text": "If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n{@see #stopAutoRefresh}\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 415,
"name": "stopAutoRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 2036,
"character": 8
}
],
"signatures": [
{
"id": 416,
"name": "stopAutoRefresh",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Stops an active auto refresh process running in the background (if any).",
"text": "If you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee {@link #startAutoRefresh} for more details.\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 358,
"name": "unlinkIdentity",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1651,
"character": 8
}
],
"signatures": [
{
"id": 359,
"name": "unlinkIdentity",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked."
},
"parameters": [
{
"id": 360,
"name": "identity",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 590,
"name": "UserIdentity"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 361,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 362,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1653,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 363,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
},
{
"id": 364,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1654,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
362,
364
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 365,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 366,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1656,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 367,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1656,
"character": 20
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
366,
367
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 247,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1098,
"character": 8
}
],
"signatures": [
{
"id": 248,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates user data for a logged in user."
},
"parameters": [
{
"id": 249,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 639,
"name": "UserAttributes"
}
},
{
"id": 250,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 251,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 252,
"name": "emailRedirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 1101,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
252
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 567,
"name": "UserResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 165,
"name": "verifyOtp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 666,
"character": 8
}
],
"signatures": [
{
"id": 166,
"name": "verifyOtp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email."
},
"parameters": [
{
"id": 167,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 736,
"name": "VerifyOtpParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 504,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
80
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
84,
85
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
139,
178,
241,
345,
126,
355,
317,
171,
278,
175,
331,
266,
159,
136,
162,
133,
168,
307,
130,
413,
415,
358,
247,
165
]
}
],
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 107,
"character": 21
}
]
},
{
"id": 464,
"name": "NavigatorLockAcquireTimeoutError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 465,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"signatures": [
{
"id": 466,
"name": "new NavigatorLockAcquireTimeoutError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 467,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 464,
"name": "NavigatorLockAcquireTimeoutError"
},
"inheritedFrom": {
"type": "reference",
"name": "LockAcquireTimeoutError.constructor"
}
}
],
"inheritedFrom": {
"type": "reference",
"name": "LockAcquireTimeoutError.constructor"
}
},
{
"id": 468,
"name": "isAcquireTimeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isReadonly": true
},
"sources": [
{
"fileName": "src/lib/locks.ts",
"line": 19,
"character": 18
}
],
"type": {
"type": "literal",
"value": true
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"name": "LockAcquireTimeoutError.isAcquireTimeout"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
465
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
468
]
}
],
"sources": [
{
"fileName": "src/lib/locks.ts",
"line": 26,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"name": "LockAcquireTimeoutError"
}
]
},
{
"id": 587,
"name": "AMREntry",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "An authentication methord reference (AMR) entry.",
"text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n",
"tags": [
{
"tag": "see",
"text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n"
}
]
},
"children": [
{
"id": 588,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Authentication method name."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 221,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 589,
"name": "timestamp",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 227,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
588,
589
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 219,
"character": 17
}
]
},
{
"id": 645,
"name": "AdminUserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 647,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.",
"text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 357,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 650,
"name": "ban_duration",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Determines how long a user is banned for.",
"text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 383,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 654,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 308,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"name": "Omit.email"
}
},
{
"id": 648,
"name": "email_confirm",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Confirms the user's email address if set to true.",
"text": "Only a service role can modify.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 364,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 653,
"name": "nonce",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
"text": "Call reauthenticate() to obtain the nonce first.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 325,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"name": "Omit.nonce"
}
},
{
"id": 652,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 318,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"name": "Omit.password"
}
},
{
"id": 655,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 313,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"name": "Omit.phone"
}
},
{
"id": 649,
"name": "phone_confirm",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Confirms the user's phone number if set to true.",
"text": "Only a service role can modify.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 371,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 651,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The `role` claim set in the user's access token JWT.",
"text": "When a user signs up, this role is set to `authenticated` by default. You should only modify the `role` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to `service_role` is not recommended as it grants the user admin privileges.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 392,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 646,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 347,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
647,
650,
654,
648,
653,
652,
655,
649,
651,
646
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 336,
"character": 17
}
],
"extendedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 639,
"name": "UserAttributes"
},
{
"type": "literal",
"value": "data"
}
],
"qualifiedName": "Omit",
"package": "typescript",
"name": "Omit"
}
]
},
{
"id": 602,
"name": "Factor",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "A MFA factor.",
"tags": [
{
"tag": "see",
"text": "{@link GoTrueMFAApi#enroll}"
},
{
"tag": "see",
"text": "{@link GoTrueMFAApi#listFactors}"
},
{
"tag": "see",
"text": "{@link GoTrueMFAAdminApi#listFactors}\n"
}
]
},
"children": [
{
"id": 607,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 266,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 605,
"name": "factor_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 261,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 604,
"name": "friendly_name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Friendly name of the factor, useful to disambiguate between multiple factors."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 255,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 603,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 252,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 606,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Factor's status."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 264,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "verified"
},
{
"type": "literal",
"value": "unverified"
}
]
}
},
{
"id": 608,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 267,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
607,
605,
604,
603,
606,
608
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 250,
"character": 17
}
]
},
{
"id": 807,
"name": "GenerateLinkOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 808,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 680,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 809,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL which will be appended to the email link generated."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 682,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
808,
809
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 674,
"character": 17
}
]
},
{
"id": 966,
"name": "GoTrueAdminMFAApi",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "Contains the full multi-factor authentication administration API.",
"tags": [
{
"tag": "expermental",
"text": "\n"
}
]
},
"children": [
{
"id": 970,
"name": "deleteFactor",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 971,
"name": "deleteFactor",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.",
"tags": [
{
"tag": "see",
"text": "{@link GoTrueMFAApi#unenroll}\n"
},
{
"tag": "expermental",
"text": "\n"
}
]
},
"parameters": [
{
"id": 972,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 950,
"name": "AuthMFAAdminDeleteFactorParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 941,
"name": "AuthMFAAdminDeleteFactorResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 967,
"name": "listFactors",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 968,
"name": "listFactors",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Lists all factors associated to a user."
},
"parameters": [
{
"id": 969,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 963,
"name": "AuthMFAAdminListFactorsParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 954,
"name": "AuthMFAAdminListFactorsResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Methods",
"kind": 2048,
"children": [
970,
967
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1012,
"character": 17
}
]
},
{
"id": 921,
"name": "GoTrueMFAApi",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "Contains the full multi-factor authentication API."
},
"children": [
{
"id": 925,
"name": "challenge",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 926,
"name": "challenge",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor."
},
"parameters": [
{
"id": 927,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 845,
"name": "MFAChallengeParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 889,
"name": "AuthMFAChallengeResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 934,
"name": "challengeAndVerify",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 935,
"name": "challengeAndVerify",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app."
},
"parameters": [
{
"id": 936,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 848,
"name": "MFAChallengeAndVerifyParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 852,
"name": "AuthMFAVerifyResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 922,
"name": "enroll",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 923,
"name": "enroll",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.",
"text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n"
},
"parameters": [
{
"id": 924,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 832,
"name": "MFAEnrollParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 865,
"name": "AuthMFAEnrollResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 939,
"name": "getAuthenticatorAssuranceLevel",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 940,
"name": "getAuthenticatorAssuranceLevel",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.",
"text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 910,
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 937,
"name": "listFactors",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 938,
"name": "listFactors",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the list of MFA factors enabled for this user.",
"tags": [
{
"tag": "see",
"text": "{@link GoTrueMFAApi#enroll}"
},
{
"tag": "see",
"text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}"
},
{
"tag": "see",
"text": "{@link GoTrueClient#getUser}\n\n"
}
]
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 899,
"name": "AuthMFAListFactorsResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 931,
"name": "unenroll",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 932,
"name": "unenroll",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor."
},
"parameters": [
{
"id": 933,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 837,
"name": "MFAUnenrollParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 880,
"name": "AuthMFAUnenrollResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 928,
"name": "verify",
"kind": 2048,
"kindString": "Method",
"flags": {},
"signatures": [
{
"id": 929,
"name": "verify",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app."
},
"parameters": [
{
"id": 930,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 840,
"name": "MFAVerifyParams"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 852,
"name": "AuthMFAVerifyResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Methods",
"kind": 2048,
"children": [
925,
934,
922,
939,
937,
931,
928
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 899,
"character": 17
}
]
},
{
"id": 578,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 581,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 194,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 584,
"name": "expires_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A timestamp of when the token will expire. Returned when a login is confirmed."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 206,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 583,
"name": "expires_in",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 202,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 580,
"name": "provider_refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 190,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 579,
"name": "provider_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 185,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 582,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "A one-time used refresh token that never expires."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 198,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 585,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 207,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 586,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 208,
"character": 2
}
],
"type": {
"type": "reference",
"id": 616,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
581,
584,
583,
580,
579,
582,
585,
586
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 181,
"character": 17
}
]
},
{
"id": 656,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 657,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The subscriber UUID. This will be set by the client."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 399,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 658,
"name": "callback",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 403,
"character": 2
}
],
"signatures": [
{
"id": 659,
"name": "callback",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"parameters": [
{
"id": 660,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 474,
"name": "AuthChangeEvent"
}
},
{
"id": 661,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 578,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 662,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 407,
"character": 2
}
],
"signatures": [
{
"id": 663,
"name": "unsubscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Call this to remove the listener."
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
657
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
658,
662
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 395,
"character": 17
}
]
},
{
"id": 664,
"name": "UpdatableFactorAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 665,
"name": "friendlyName",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 411,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
665
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 410,
"character": 17
}
]
},
{
"id": 616,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 627,
"name": "action_link",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 290,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 618,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 281,
"character": 2
}
],
"type": {
"type": "reference",
"id": 609,
"name": "UserAppMetadata"
}
},
{
"id": 620,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 283,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 621,
"name": "confirmation_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 284,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 631,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 294,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 630,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 293,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 628,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 291,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 623,
"name": "email_change_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 286,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 632,
"name": "email_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 295,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 638,
"name": "factors",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 301,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 602,
"name": "Factor"
}
}
},
{
"id": 617,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 280,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 637,
"name": "identities",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 300,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 590,
"name": "UserIdentity"
}
}
},
{
"id": 626,
"name": "invited_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 289,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 634,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 297,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 624,
"name": "new_email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 287,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 625,
"name": "new_phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 288,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 629,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 292,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 633,
"name": "phone_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 296,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 622,
"name": "recovery_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 285,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 635,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 298,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 636,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 299,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 619,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 282,
"character": 2
}
],
"type": {
"type": "reference",
"id": 613,
"name": "UserMetadata"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
627,
618,
620,
621,
631,
630,
628,
623,
632,
638,
617,
637,
626,
634,
624,
625,
629,
633,
622,
635,
636,
619
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 279,
"character": 17
}
]
},
{
"id": 609,
"name": "UserAppMetadata",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 610,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 271,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
610
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 270,
"character": 17
}
],
"indexSignature": {
"id": 611,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 612,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
},
{
"id": 639,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 644,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 333,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 640,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 308,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 643,
"name": "nonce",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The nonce sent for reauthentication if the user's password is to be updated.",
"text": "Call reauthenticate() to obtain the nonce first.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 325,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 642,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 318,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 641,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 313,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
644,
640,
643,
642,
641
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 304,
"character": 17
}
]
},
{
"id": 590,
"name": "UserIdentity",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 599,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 238,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 591,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 231,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 593,
"name": "identity_data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 233,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 594,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 595,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 596,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 597,
"name": "identity_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 236,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 600,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 239,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 598,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 237,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 601,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 240,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 592,
"name": "user_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 232,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
599,
591,
593,
597,
600,
598,
601,
592
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 230,
"character": 17
}
]
},
{
"id": 613,
"name": "UserMetadata",
"kind": 256,
"kindString": "Interface",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 275,
"character": 17
}
],
"indexSignature": {
"id": 614,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 615,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
},
{
"id": 745,
"name": "VerifyEmailOtpParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 746,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email address."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 570,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 749,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 575,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 750,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 752,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site.",
"tags": [
{
"tag": "deprecated",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 583,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 751,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 577,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
752,
751
]
}
]
}
}
},
{
"id": 747,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The otp sent to the user's email address."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 572,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 748,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's verification type."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 574,
"character": 2
}
],
"type": {
"type": "reference",
"id": 757,
"name": "EmailOtpType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
746,
749,
747,
748
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 568,
"character": 17
}
]
},
{
"id": 737,
"name": "VerifyMobileOtpParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 741,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 556,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 742,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 744,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site.",
"tags": [
{
"tag": "deprecated",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 565,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 743,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 558,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
744,
743
]
}
]
}
}
},
{
"id": 738,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's phone number."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 551,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 739,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The otp sent to the user's phone number."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 553,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 740,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's verification type."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 555,
"character": 2
}
],
"type": {
"type": "reference",
"id": 756,
"name": "MobileOtpType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
741,
738,
739,
740
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 549,
"character": 17
}
]
},
{
"id": 753,
"name": "VerifyTokenHashParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 754,
"name": "token_hash",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The token hash used in an email link"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 589,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 755,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's verification type."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 592,
"character": 2
}
],
"type": {
"type": "reference",
"id": 757,
"name": "EmailOtpType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
754,
755
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 587,
"character": 17
}
]
},
{
"id": 474,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 30,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "INITIAL_SESSION"
},
{
"type": "literal",
"value": "PASSWORD_RECOVERY"
},
{
"type": "literal",
"value": "SIGNED_IN"
},
{
"type": "literal",
"value": "SIGNED_OUT"
},
{
"type": "literal",
"value": "TOKEN_REFRESHED"
},
{
"type": "literal",
"value": "USER_UPDATED"
},
{
"type": "reference",
"id": 473,
"name": "AuthChangeEventMFA"
}
]
}
},
{
"id": 473,
"name": "AuthChangeEventMFA",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 12
}
],
"type": {
"type": "literal",
"value": "MFA_CHALLENGE_VERIFIED"
}
},
{
"id": 714,
"name": "AuthFlowType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 517,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "implicit"
},
{
"type": "literal",
"value": "pkce"
}
]
}
},
{
"id": 950,
"name": "AuthMFAAdminDeleteFactorParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"tags": [
{
"tag": "expermental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 978,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 951,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 952,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the MFA factor to delete."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 980,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 953,
"name": "userId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the user whose factor is being deleted."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 983,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
952,
953
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 978,
"character": 45
}
]
}
}
},
{
"id": 941,
"name": "AuthMFAAdminDeleteFactorResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"tags": [
{
"tag": "expermental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 965,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 942,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 943,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 967,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 944,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 945,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor that was successfully deleted."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 969,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
945
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 967,
"character": 12
}
]
}
}
},
{
"id": 946,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 971,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
943,
946
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 966,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 947,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 948,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 973,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 949,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 973,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
948,
949
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 973,
"character": 4
}
]
}
}
]
}
},
{
"id": 963,
"name": "AuthMFAAdminListFactorsParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"tags": [
{
"tag": "expermental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1002,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 964,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 965,
"name": "userId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the user."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1004,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
965
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1002,
"character": 44
}
]
}
}
},
{
"id": 954,
"name": "AuthMFAAdminListFactorsResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"tags": [
{
"tag": "expermental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 989,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 955,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 956,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 991,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 957,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 958,
"name": "factors",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "All factors attached to the user."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 993,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 602,
"name": "Factor"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
958
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 991,
"character": 12
}
]
}
}
},
{
"id": 959,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 995,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
956,
959
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 990,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 960,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 961,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 997,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 962,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 997,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
961,
962
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 997,
"character": 4
}
]
}
}
]
}
},
{
"id": 889,
"name": "AuthMFAChallengeResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 842,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 890,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 891,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 844,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 892,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 894,
"name": "expires_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 849,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 893,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the newly created challenge."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 846,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
894,
893
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 844,
"character": 12
}
]
}
}
},
{
"id": 895,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 851,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
891,
895
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 843,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 896,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 897,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 853,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 898,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 853,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
897,
898
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 853,
"character": 4
}
]
}
}
]
}
},
{
"id": 865,
"name": "AuthMFAEnrollResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 799,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 866,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 867,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 801,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 868,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 869,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor that was just enrolled (in an unverified state)."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 803,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 871,
"name": "totp",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "TOTP enrollment information."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 809,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 872,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 873,
"name": "qr_code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 813,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 874,
"name": "secret",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 818,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 875,
"name": "uri",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 822,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
873,
874,
875
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 809,
"character": 14
}
]
}
}
},
{
"id": 870,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Type of MFA factor. Only `totp` supported for now."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 806,
"character": 8
}
],
"type": {
"type": "literal",
"value": "totp"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
869,
871,
870
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 801,
"character": 12
}
]
}
}
},
{
"id": 876,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 825,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
867,
876
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 800,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 877,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 878,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 828,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 879,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 829,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
878,
879
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 827,
"character": 4
}
]
}
}
]
}
},
{
"id": 910,
"name": "AuthMFAGetAuthenticatorAssuranceLevelResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 870,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 911,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 912,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 872,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 913,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 916,
"name": "currentAuthenticationMethods",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 889,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 587,
"name": "AMREntry"
}
}
},
{
"id": 914,
"name": "currentLevel",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Current AAL level of the session."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 874,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 909,
"name": "AuthenticatorAssuranceLevels"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 915,
"name": "nextLevel",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.",
"tags": [
{
"tag": "see",
"text": "{@link GoTrueMFAApi#challenge}\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 882,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 909,
"name": "AuthenticatorAssuranceLevels"
},
{
"type": "literal",
"value": null
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
916,
914,
915
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 872,
"character": 12
}
]
}
}
},
{
"id": 917,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 891,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
912,
917
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 871,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 918,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 919,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 893,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 920,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 893,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
919,
920
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 893,
"character": 4
}
]
}
}
]
}
},
{
"id": 899,
"name": "AuthMFAListFactorsResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 855,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 900,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 901,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 857,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 902,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 903,
"name": "all",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "All available factors (verified and unverified)."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 859,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 602,
"name": "Factor"
}
}
},
{
"id": 904,
"name": "totp",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Only verified TOTP factors. (A subset of `all`.)"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 862,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 602,
"name": "Factor"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
903,
904
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 857,
"character": 12
}
]
}
}
},
{
"id": 905,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 864,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
901,
905
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 856,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 906,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 907,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 866,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 908,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 866,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
907,
908
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 866,
"character": 4
}
]
}
}
]
}
},
{
"id": 880,
"name": "AuthMFAUnenrollResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 832,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 881,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 882,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 834,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 883,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 884,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor that was successfully unenrolled."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 836,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
884
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 834,
"character": 12
}
]
}
}
},
{
"id": 885,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 838,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
882,
885
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 833,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 886,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 887,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 840,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 888,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 840,
"character": 18
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
887,
888
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 840,
"character": 4
}
]
}
}
]
}
},
{
"id": 852,
"name": "AuthMFAVerifyResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 774,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 853,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 854,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 776,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 855,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 856,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "New access token (JWT) after successful verification."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 778,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 858,
"name": "expires_in",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Number of seconds in which the access token will expire."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 784,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 859,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Refresh token you can use to obtain new access tokens when expired."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 787,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 857,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Type of token, typically `Bearer`."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 781,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 860,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Updated user profile."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 790,
"character": 8
}
],
"type": {
"type": "reference",
"id": 616,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
856,
858,
859,
857,
860
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 776,
"character": 12
}
]
}
}
},
{
"id": 861,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 792,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
854,
861
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 775,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 862,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 863,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 795,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 864,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 796,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
863,
864
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 794,
"character": 4
}
]
}
}
]
}
},
{
"id": 517,
"name": "AuthOtpResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"shortText": "AuthOtpResponse is returned when OTP is used.",
"text": "{@see AuthRsponse}\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 106,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 518,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 519,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 520,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 523,
"name": "messageId",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 41
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 522,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 26
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 521,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 14
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
523,
522,
521
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 12
}
]
}
}
},
{
"id": 524,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 109,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
519,
524
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 107,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 525,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 526,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 527,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 530,
"name": "messageId",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 41
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 529,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 26
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 528,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 14
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
530,
529,
528
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 12
}
]
}
}
},
{
"id": 531,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 113,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
526,
531
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 111,
"character": 4
}
]
}
}
]
}
},
{
"id": 504,
"name": "AuthResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 85,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 505,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 506,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 87,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 507,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 509,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 89,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 578,
"name": "Session"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 508,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 88,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 616,
"name": "User"
},
{
"type": "literal",
"value": null
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
509,
508
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 87,
"character": 12
}
]
}
}
},
{
"id": 510,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 91,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
506,
510
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 511,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 512,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 94,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 513,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 515,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 96,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 514,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 95,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
515,
514
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 94,
"character": 12
}
]
}
}
},
{
"id": 516,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 98,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
512,
516
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 93,
"character": 4
}
]
}
}
]
}
},
{
"id": 532,
"name": "AuthTokenResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 116,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 533,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 534,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 118,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 535,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 537,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 120,
"character": 8
}
],
"type": {
"type": "reference",
"id": 578,
"name": "Session"
}
},
{
"id": 536,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 119,
"character": 8
}
],
"type": {
"type": "reference",
"id": 616,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
537,
536
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 118,
"character": 12
}
]
}
}
},
{
"id": 538,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 122,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
534,
538
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 117,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 539,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 540,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 125,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 541,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 543,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 127,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 542,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 126,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
543,
542
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 125,
"character": 12
}
]
}
}
},
{
"id": 544,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 129,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
540,
544
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 124,
"character": 4
}
]
}
}
]
}
},
{
"id": 909,
"name": "AuthenticatorAssuranceLevels",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 868,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "aal1"
},
{
"type": "literal",
"value": "aal2"
}
]
}
},
{
"id": 977,
"name": "CallRefreshTokenResult",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1043,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 978,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 980,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1046,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 979,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1045,
"character": 6
}
],
"type": {
"type": "reference",
"id": 578,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
980,
979
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1044,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 981,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 983,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1050,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
},
{
"id": 982,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1049,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
983,
982
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1048,
"character": 4
}
]
}
}
]
}
},
{
"id": 757,
"name": "EmailOtpType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 596,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "signup"
},
{
"type": "literal",
"value": "invite"
},
{
"type": "literal",
"value": "magiclink"
},
{
"type": "literal",
"value": "recovery"
},
{
"type": "literal",
"value": "email_change"
},
{
"type": "literal",
"value": "email"
}
]
}
},
{
"id": 801,
"name": "GenerateEmailChangeLinkParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 663,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 802,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 804,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 666,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 805,
"name": "newEmail",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 670,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 806,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 671,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 807,
"name": "GenerateLinkOptions"
},
{
"type": "literal",
"value": "redirectTo"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 803,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 664,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "email_change_current"
},
{
"type": "literal",
"value": "email_change_new"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
804,
805,
806,
803
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 663,
"character": 44
}
]
}
}
},
{
"id": 791,
"name": "GenerateInviteOrMagiclinkParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 649,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 792,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 794,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 652,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 795,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 653,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 807,
"name": "GenerateLinkOptions"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "data"
},
{
"type": "literal",
"value": "redirectTo"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 793,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 650,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "invite"
},
{
"type": "literal",
"value": "magiclink"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
794,
795,
793
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 649,
"character": 46
}
]
}
}
},
{
"id": 810,
"name": "GenerateLinkParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 685,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 785,
"name": "GenerateSignupLinkParams"
},
{
"type": "reference",
"id": 791,
"name": "GenerateInviteOrMagiclinkParams"
},
{
"type": "reference",
"id": 796,
"name": "GenerateRecoveryLinkParams"
},
{
"type": "reference",
"id": 801,
"name": "GenerateEmailChangeLinkParams"
}
]
}
},
{
"id": 824,
"name": "GenerateLinkProperties",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"shortText": "The properties related to the email link generated"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 708,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 825,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 826,
"name": "action_link",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 713,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 827,
"name": "email_otp",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 718,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 828,
"name": "hashed_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The hashed token appended to the action link."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 722,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 829,
"name": "redirect_to",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The URL appended to the action link."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 724,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 830,
"name": "verification_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The verification type that the email link is associated to."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 726,
"character": 2
}
],
"type": {
"type": "reference",
"id": 831,
"name": "GenerateLinkType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
826,
827,
828,
829,
830
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 708,
"character": 37
}
]
}
}
},
{
"id": 811,
"name": "GenerateLinkResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 691,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 812,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 813,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 693,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 814,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 815,
"name": "properties",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 694,
"character": 8
}
],
"type": {
"type": "reference",
"id": 824,
"name": "GenerateLinkProperties"
}
},
{
"id": 816,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 695,
"character": 8
}
],
"type": {
"type": "reference",
"id": 616,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
815,
816
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 693,
"character": 12
}
]
}
}
},
{
"id": 817,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 697,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
813,
817
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 692,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 818,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 819,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 700,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 820,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 821,
"name": "properties",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 701,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 822,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 702,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
821,
822
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 700,
"character": 12
}
]
}
}
},
{
"id": 823,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 704,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
819,
823
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 699,
"character": 4
}
]
}
}
]
}
},
{
"id": 831,
"name": "GenerateLinkType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 729,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "signup"
},
{
"type": "literal",
"value": "invite"
},
{
"type": "literal",
"value": "magiclink"
},
{
"type": "literal",
"value": "recovery"
},
{
"type": "literal",
"value": "email_change_current"
},
{
"type": "literal",
"value": "email_change_new"
}
]
}
},
{
"id": 796,
"name": "GenerateRecoveryLinkParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 656,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 797,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 799,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 659,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 800,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 660,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 807,
"name": "GenerateLinkOptions"
},
{
"type": "literal",
"value": "redirectTo"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 798,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 657,
"character": 2
}
],
"type": {
"type": "literal",
"value": "recovery"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
799,
800,
798
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 656,
"character": 41
}
]
}
}
},
{
"id": 785,
"name": "GenerateSignupLinkParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 642,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 786,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 788,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 644,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 790,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 646,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 807,
"name": "GenerateLinkOptions"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "data"
},
{
"type": "literal",
"value": "redirectTo"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 789,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 645,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 787,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 643,
"character": 2
}
],
"type": {
"type": "literal",
"value": "signup"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
788,
790,
789,
787
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 642,
"character": 39
}
]
}
}
},
{
"id": 484,
"name": "GoTrueClientOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 56,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 485,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 493,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 66,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 498,
"name": "debug",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 76,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "boolean"
},
{
"type": "reflection",
"declaration": {
"id": 499,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 76,
"character": 21
}
],
"signatures": [
{
"id": 500,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 501,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 502,
"name": "args",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isRest": true
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
]
}
},
{
"id": 492,
"name": "detectSessionInUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 64,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 496,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 72,
"character": 2
}
],
"type": {
"type": "reference",
"name": "Fetch"
}
},
{
"id": 497,
"name": "flowType",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 74,
"character": 2
}
],
"type": {
"type": "reference",
"id": 714,
"name": "AuthFlowType"
}
},
{
"id": 487,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 60,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 488,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 60,
"character": 12
}
],
"indexSignature": {
"id": 489,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 490,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 503,
"name": "lock",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Provide your own locking mechanism based on the environment. By default no locking is done at this time.",
"tags": [
{
"tag": "experimental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 2
}
],
"type": {
"type": "reference",
"id": 475,
"name": "LockFunc"
}
},
{
"id": 494,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 68,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 495,
"name": "storage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 70,
"character": 2
}
],
"type": {
"type": "reference",
"id": 973,
"name": "SupportedStorage"
}
},
{
"id": 491,
"name": "storageKey",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 486,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 58,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
493,
498,
492,
496,
497,
487,
503,
494,
495,
491,
486
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 56,
"character": 34
}
]
}
}
},
{
"id": 974,
"name": "InitializeResult",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1041,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 975,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 976,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1041,
"character": 33
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 1010,
"name": "AuthError"
},
{
"type": "literal",
"value": null
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
976
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1041,
"character": 31
}
]
}
}
},
{
"id": 475,
"name": "LockFunc",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 476,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 23
}
],
"signatures": [
{
"id": 477,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n`fn` async function, such that no other client instances will be able to\nhold it at the same time.",
"tags": [
{
"tag": "experimental",
"text": "\n"
}
]
},
"typeParameter": [
{
"id": 483,
"name": "R",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"parameters": [
{
"id": 478,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Name of the lock to be acquired."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 479,
"name": "acquireTimeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "If negative, no timeout should occur. If positive it\n should throw an Error with an `isAcquireTimeout`\n property set to true if the operation fails to be\n acquired after this much time (ms)."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 480,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The operation to execute when the lock is acquired.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 481,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 69
}
],
"signatures": [
{
"id": 482,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 483,
"name": "R"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 483,
"name": "R"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 848,
"name": "MFAChallengeAndVerifyParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 767,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 849,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 851,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Verification code provided by the user."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 771,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 850,
"name": "factorId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor being verified. Returned in enroll()."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 769,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
851,
850
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 767,
"character": 42
}
]
}
}
},
{
"id": 845,
"name": "MFAChallengeParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 762,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 846,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 847,
"name": "factorId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor to be challenged. Returned in enroll()."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 764,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
847
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 762,
"character": 33
}
]
}
}
},
{
"id": 832,
"name": "MFAEnrollParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 737,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 833,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 834,
"name": "factorType",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The type of factor being enrolled."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 739,
"character": 2
}
],
"type": {
"type": "literal",
"value": "totp"
}
},
{
"id": 836,
"name": "friendlyName",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Human readable name assigned to the factor."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 743,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 835,
"name": "issuer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Domain which the user is enrolled with."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 741,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
834,
836,
835
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 737,
"character": 30
}
]
}
}
},
{
"id": 837,
"name": "MFAUnenrollParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 746,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 838,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 839,
"name": "factorId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor being unenrolled."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 748,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
839
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 746,
"character": 32
}
]
}
}
},
{
"id": 840,
"name": "MFAVerifyParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 751,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 841,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 843,
"name": "challengeId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the challenge being verified. Returned in challenge()."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 756,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 844,
"name": "code",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Verification code provided by the user."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 759,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 842,
"name": "factorId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "ID of the factor being verified. Returned in enroll()."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 753,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
843,
844,
842
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 751,
"character": 30
}
]
}
}
},
{
"id": 756,
"name": "MobileOtpType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 595,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "phone_change"
}
]
}
},
{
"id": 545,
"name": "OAuthResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 132,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 546,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 547,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 134,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 548,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 549,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 135,
"character": 8
}
],
"type": {
"type": "reference",
"id": 472,
"name": "Provider"
}
},
{
"id": 550,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 136,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
549,
550
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 134,
"character": 12
}
]
}
}
},
{
"id": 551,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 138,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
547,
551
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 133,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 552,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 553,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 141,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 554,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 555,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 142,
"character": 8
}
],
"type": {
"type": "reference",
"id": 472,
"name": "Provider"
}
},
{
"id": 556,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 143,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
555,
556
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 141,
"character": 12
}
]
}
}
},
{
"id": 557,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 145,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
553,
557
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 140,
"character": 4
}
]
}
}
]
}
},
{
"id": 991,
"name": "PageParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1060,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 992,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 993,
"name": "page",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The page number"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1062,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 994,
"name": "perPage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Number of items returned per page"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1064,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
993,
994
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1060,
"character": 25
}
]
}
}
},
{
"id": 984,
"name": "Pagination",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1053,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 985,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 987,
"name": "lastPage",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1056,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 986,
"name": "nextPage",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1055,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 988,
"name": "total",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1057,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
987,
986,
988
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1053,
"character": 25
}
],
"indexSignature": {
"id": 989,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 990,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 472,
"name": "Provider",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"shortText": "One of the providers supported by GoTrue."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 5,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "apple"
},
{
"type": "literal",
"value": "azure"
},
{
"type": "literal",
"value": "bitbucket"
},
{
"type": "literal",
"value": "discord"
},
{
"type": "literal",
"value": "facebook"
},
{
"type": "literal",
"value": "figma"
},
{
"type": "literal",
"value": "github"
},
{
"type": "literal",
"value": "gitlab"
},
{
"type": "literal",
"value": "google"
},
{
"type": "literal",
"value": "kakao"
},
{
"type": "literal",
"value": "keycloak"
},
{
"type": "literal",
"value": "linkedin"
},
{
"type": "literal",
"value": "linkedin_oidc"
},
{
"type": "literal",
"value": "notion"
},
{
"type": "literal",
"value": "slack"
},
{
"type": "literal",
"value": "spotify"
},
{
"type": "literal",
"value": "twitch"
},
{
"type": "literal",
"value": "twitter"
},
{
"type": "literal",
"value": "workos"
},
{
"type": "literal",
"value": "zoom"
},
{
"type": "literal",
"value": "fly"
}
]
}
},
{
"id": 758,
"name": "ResendParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 598,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 759,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 761,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 601,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 762,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 602,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 763,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 765,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 606,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 764,
"name": "emailRedirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they have signed-in."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 604,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
765,
764
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 602,
"character": 16
}
]
}
}
},
{
"id": 760,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 600,
"character": 6
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 757,
"name": "EmailOtpType"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "signup"
},
{
"type": "literal",
"value": "email_change"
}
]
}
],
"qualifiedName": "Extract",
"package": "typescript",
"name": "Extract"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
761,
762,
760
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 599,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 766,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 769,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 612,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 770,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 771,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 614,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
771
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 612,
"character": 16
}
]
}
}
},
{
"id": 768,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 611,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 767,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 610,
"character": 6
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 756,
"name": "MobileOtpType"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "phone_change"
}
]
}
],
"qualifiedName": "Extract",
"package": "typescript",
"name": "Extract"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
769,
768,
767
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 609,
"character": 4
}
]
}
}
]
}
},
{
"id": 558,
"name": "SSOResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 148,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 559,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 560,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 150,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 561,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 562,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.",
"text": "On browsers you can set the URL to `window.location.href` to take\nthe user to the authentication flow.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 158,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
562
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 150,
"character": 12
}
]
}
}
},
{
"id": 563,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 160,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
560,
563
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 149,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 564,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 565,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 163,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 566,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 164,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
565,
566
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 162,
"character": 4
}
]
}
}
]
}
},
{
"id": 727,
"name": "SignInWithIdTokenCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 533,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 728,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 731,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "If the ID token contains an `at_hash` claim, then the hash of this value is compared to the value in the ID token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 539,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 732,
"name": "nonce",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "If the ID token contains a `nonce` claim, then the hash of this value is compared to the value in the ID token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 541,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 733,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 542,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 734,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 735,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 544,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
735
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 542,
"character": 12
}
]
}
}
},
{
"id": 729,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Provider name or OIDC `iss` value identifying which provider should be used to verify the provided token. Supported names: `google`, `apple`, `azure`, `facebook`, `keycloak` (deprecated)."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 535,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "google"
},
{
"type": "literal",
"value": "apple"
},
{
"type": "literal",
"value": "azure"
},
{
"type": "literal",
"value": "facebook"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 730,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "OIDC ID token issued by the specified provider. The `iss` claim in the ID token must match the supplied provider. Some ID tokens contain an `at_hash` which require that you provide an `access_token` value to be accepted properly. If the token contains a `nonce` claim you must supply the nonce used to obtain the ID token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 537,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
731,
732,
733,
729,
730
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 533,
"character": 43
}
]
}
}
},
{
"id": 715,
"name": "SignInWithOAuthCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 518,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 716,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 718,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 521,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 719,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 722,
"name": "queryParams",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An object of query params"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 527,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 723,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 527,
"character": 18
}
],
"indexSignature": {
"id": 724,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 725,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 720,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 523,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 721,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A space-separated list of scopes granted to the OAuth application."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 525,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 726,
"name": "skipBrowserRedirect",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 529,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
722,
720,
721,
726
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 521,
"character": 12
}
]
}
}
},
{
"id": 717,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "One of the providers supported by GoTrue."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 520,
"character": 2
}
],
"type": {
"type": "reference",
"id": 472,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
718,
717
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 518,
"character": 41
}
]
}
}
},
{
"id": 683,
"name": "SignInWithPasswordCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 451,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 684,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 685,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email address."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 454,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 687,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 457,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 688,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 689,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 459,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
689
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 457,
"character": 16
}
]
}
}
},
{
"id": 686,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 456,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
685,
687,
686
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 452,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 690,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 693,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 467,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 694,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 696,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 475,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 695,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 473,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
696,
695
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 467,
"character": 16
}
]
}
}
},
{
"id": 692,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 466,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 691,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's phone number."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 464,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
693,
692,
691
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 462,
"character": 4
}
]
}
}
]
}
},
{
"id": 697,
"name": "SignInWithPasswordlessCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 479,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 698,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 699,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email address."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 482,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 700,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 483,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 701,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 705,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 495,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 704,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 493,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 702,
"name": "emailRedirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The redirect url embedded in the email link"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 485,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 703,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "If set to false, this method will not create a new user. Defaults to true."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 487,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
705,
704,
702,
703
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 483,
"character": 16
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
699,
700
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 480,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 706,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 708,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 501,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 709,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 712,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 511,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 713,
"name": "channel",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 513,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "whatsapp"
}
]
}
},
{
"id": 711,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 509,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 710,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "If set to false, this method will not create a new user. Defaults to true."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 503,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
712,
713,
711,
710
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 501,
"character": 16
}
]
}
}
},
{
"id": 707,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's phone number."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 500,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
708,
707
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 498,
"character": 4
}
]
}
}
]
}
},
{
"id": 772,
"name": "SignInWithSSO",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 618,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 773,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 775,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 623,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 776,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 778,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 627,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 777,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they have signed-in."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 625,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
778,
777
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 623,
"character": 16
}
]
}
}
},
{
"id": 774,
"name": "providerId",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "UUID of the SSO provider to invoke single-sign on to."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 621,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
775,
774
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 619,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 779,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 780,
"name": "domain",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Domain name of the organization for which to invoke single-sign on."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 632,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 781,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 634,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 782,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 784,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 638,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 783,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL to send the user to after they have signed-in."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 636,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
784,
783
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 634,
"character": 16
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
780,
781
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 630,
"character": 4
}
]
}
}
]
}
},
{
"id": 995,
"name": "SignOut",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1067,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 996,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 997,
"name": "scope",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1078,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "global"
},
{
"type": "literal",
"value": "local"
},
{
"type": "literal",
"value": "others"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
997
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1067,
"character": 22
}
]
}
}
},
{
"id": 666,
"name": "SignUpWithPasswordCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 414,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 667,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 668,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's email address."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 417,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 670,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 420,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 671,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 674,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 430,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 673,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 428,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 672,
"name": "emailRedirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The redirect url embedded in the email link"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 422,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
674,
673,
672
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 420,
"character": 16
}
]
}
}
},
{
"id": 669,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 419,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
668,
670,
669
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 415,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 675,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 678,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 438,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 679,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 681,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 446,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 682,
"name": "channel",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Messaging channel to use (e.g. whatsapp or sms)"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 448,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "whatsapp"
}
]
}
},
{
"id": 680,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.",
"text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 444,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
681,
682,
680
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 438,
"character": 16
}
]
}
}
},
{
"id": 677,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 437,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 676,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The user's phone number."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 435,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
678,
677,
676
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 433,
"character": 4
}
]
}
}
]
}
},
{
"id": 973,
"name": "SupportedStorage",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1039,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Storage",
"package": "typescript",
"name": "Storage"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "getItem"
},
{
"type": "literal",
"value": "setItem"
},
{
"type": "literal",
"value": "removeItem"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 567,
"name": "UserResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 167,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 568,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 569,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 169,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 570,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 571,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 170,
"character": 8
}
],
"type": {
"type": "reference",
"id": 616,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
571
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 169,
"character": 12
}
]
}
}
},
{
"id": 572,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 172,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
569,
572
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 168,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 573,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 574,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 175,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 575,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 576,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 176,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
576
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 175,
"character": 12
}
]
}
}
},
{
"id": 577,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 178,
"character": 6
}
],
"type": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
574,
577
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 174,
"character": 4
}
]
}
}
]
}
},
{
"id": 736,
"name": "VerifyOtpParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 548,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 737,
"name": "VerifyMobileOtpParams"
},
{
"type": "reference",
"id": 745,
"name": "VerifyEmailOtpParams"
},
{
"type": "reference",
"id": 753,
"name": "VerifyTokenHashParams"
}
]
}
},
{
"id": 469,
"name": "lockInternals",
"kind": 32,
"kindString": "Variable",
"flags": {
"isConst": true
},
"comment": {
"tags": [
{
"tag": "experimental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/locks.ts",
"line": 6,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 470,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 471,
"name": "debug",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"tags": [
{
"tag": "experimental",
"text": "\n"
}
]
},
"sources": [
{
"fileName": "src/lib/locks.ts",
"line": 10,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "!!(\n globalThis &&\n supportsLocalStorage() &&\n globalThis.localStorage &&\n globalThis.localStorage.getItem('supabase.gotrue-js.locks.debug') === 'true'\n )"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
471
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 1001,
"name": "isAuthApiError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 34,
"character": 16
}
],
"signatures": [
{
"id": 1002,
"name": "isAuthApiError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 1003,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 1017,
"name": "AuthApiError"
}
}
}
]
},
{
"id": 998,
"name": "isAuthError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 12,
"character": 16
}
],
"signatures": [
{
"id": 999,
"name": "isAuthError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 1000,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 1010,
"name": "AuthError"
}
}
}
]
},
{
"id": 1004,
"name": "isAuthRetryableFetchError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 124,
"character": 16
}
],
"signatures": [
{
"id": 1005,
"name": "isAuthRetryableFetchError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 1006,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 1140,
"name": "AuthRetryableFetchError"
}
}
}
]
},
{
"id": 1007,
"name": "isAuthWeakPasswordError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 146,
"character": 16
}
],
"signatures": [
{
"id": 1008,
"name": "isAuthWeakPasswordError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 1009,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 1154,
"name": "AuthWeakPasswordError"
}
}
}
]
},
{
"id": 456,
"name": "navigatorLock",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/locks.ts",
"line": 55,
"character": 22
}
],
"signatures": [
{
"id": 457,
"name": "navigatorLock",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring {@link\nGoTrueClient}.",
"text": "You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`\nlocal storage item to `true`.\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the `request` method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the `fn`\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway.\n",
"tags": [
{
"tag": "experimental",
"text": "\n"
}
]
},
"typeParameter": [
{
"id": 458,
"name": "R",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"parameters": [
{
"id": 459,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Name of the lock to be acquired."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 460,
"name": "acquireTimeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has `isAcquireTimeout` set to true."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 461,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The operation to run once the lock is acquired.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 462,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 463,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 458,
"name": "R"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 458,
"name": "R"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
1017,
1010,
1090,
1077,
1065,
1115,
1140,
1053,
1030,
1154,
1038,
1,
78,
464
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
587,
645,
602,
807,
966,
921,
578,
656,
664,
616,
609,
639,
590,
613,
745,
737,
753
]
},
{
"title": "Type Aliases",
"kind": 4194304,
"children": [
474,
473,
714,
950,
941,
963,
954,
889,
865,
910,
899,
880,
852,
517,
504,
532,
909,
977,
757,
801,
791,
810,
824,
811,
831,
796,
785,
484,
974,
475,
848,
845,
832,
837,
840,
756,
545,
991,
984,
472,
758,
558,
727,
715,
683,
697,
772,
995,
666,
973,
567,
736
]
},
{
"title": "Variables",
"kind": 32,
"children": [
469
]
},
{
"title": "Functions",
"kind": 64,
"children": [
1001,
998,
1004,
1007,
456
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
}