dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-08 02:45:07 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3cea779b7fc5ac384eeec4e73a8eb84bcca3db05
supabase/web/spec/gotrue.json
T

9116 lines
196 KiB
JSON
Raw Blame History

{
"id": 0,
"name": "@supabase/gotrue-js",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 1,
"name": "GoTrueApi",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 16,
"character": 2
}
],
"signatures": [
{
"id": 3,
"name": "new GoTrueApi",
"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": "cookieOptions",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 26,
"character": 4
}
],
"type": {
"type": "reference",
"id": 455,
"name": "CookieOptions"
}
},
{
"id": 12,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 27,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 13,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 14,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 15,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RequestInfo"
}
},
{
"id": 16,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "Response"
}
],
"name": "Promise"
}
}
]
}
}
},
{
"id": 7,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 23,
"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/GoTrueApi.ts",
"line": 22,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
11,
12,
7,
6
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
}
]
},
{
"id": 22,
"name": "cookieOptions",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 13,
"character": 12
}
],
"type": {
"type": "reference",
"id": 455,
"name": "CookieOptions"
}
},
{
"id": 23,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 24,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 25,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 26,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RequestInfo"
}
},
{
"id": 27,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "Response"
}
],
"name": "Promise"
}
}
]
}
}
},
{
"id": 18,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 10,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 19,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 20,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 21,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 17,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 9,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 130,
"name": "_createRequestHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 333,
"character": 10
}
],
"signatures": [
{
"id": 131,
"name": "_createRequestHeaders",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods"
},
"parameters": [
{
"id": 132,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 133,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
}
]
},
{
"id": 28,
"name": "createUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 43,
"character": 8
}
],
"signatures": [
{
"id": 29,
"name": "createUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user.",
"text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"parameters": [
{
"id": 30,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to create the user with."
},
"type": {
"type": "reference",
"id": 442,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"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/GoTrueApi.ts",
"line": 45,
"character": 15
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 33,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 45,
"character": 27
}
],
"type": {
"type": "reference",
"id": 394,
"name": "ApiError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
32,
33
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 34,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 35,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 45,
"character": 49
}
],
"type": {
"type": "reference",
"id": 416,
"name": "User"
}
},
{
"id": 36,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 45,
"character": 61
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
35,
36
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 161,
"name": "deleteUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 424,
"character": 8
}
],
"signatures": [
{
"id": 162,
"name": "deleteUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Delete a user. Requires a `service_role` key.",
"text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"parameters": [
{
"id": 163,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user uid you want to remove."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 164,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid JWT. Must be a full-access API key (e.g. service_role key).\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 165,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 167,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 427,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 168,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 427,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 166,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 427,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
167,
168,
166
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 187,
"name": "generateLink",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 527,
"character": 8
}
],
"signatures": [
{
"id": 188,
"name": "generateLink",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates links to be sent via email or other."
},
"parameters": [
{
"id": 189,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\")."
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "signup"
},
{
"type": "literal",
"value": "magiclink"
},
{
"type": "literal",
"value": "recovery"
},
{
"type": "literal",
"value": "invite"
}
]
}
},
{
"id": 190,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's email."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 191,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 192,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 194,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 532,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 193,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 531,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 195,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 533,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
194,
193,
195
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 196,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 197,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 535,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 198,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 535,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
197,
198
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 139,
"name": "getUrlForProvider",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 363,
"character": 2
}
],
"signatures": [
{
"id": 140,
"name": "getUrlForProvider",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates the relevant login URL for a third-party provider."
},
"parameters": [
{
"id": 141,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "One of the providers supported by GoTrue."
},
"type": {
"type": "reference",
"id": 392,
"name": "Provider"
}
},
{
"id": 142,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 143,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 144,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 366,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 145,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 367,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
144,
145
]
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 146,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 384,
"character": 8
}
],
"signatures": [
{
"id": 147,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the user details."
},
"parameters": [
{
"id": 148,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 149,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 151,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 386,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 152,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 386,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 150,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 386,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
151,
152,
150
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 179,
"name": "getUserByCookie",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 495,
"character": 8
}
],
"signatures": [
{
"id": 180,
"name": "getUserByCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)."
},
"parameters": [
{
"id": 181,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 182,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 185,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 498,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 186,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 499,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 183,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 496,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 184,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 497,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
185,
186,
183,
184
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 110,
"name": "inviteUserByEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 274,
"character": 8
}
],
"signatures": [
{
"id": 111,
"name": "inviteUserByEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends an invite link to an email address."
},
"parameters": [
{
"id": 112,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 113,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 114,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 116,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 278,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 115,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 277,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
116,
115
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 117,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 118,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 280,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 119,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 280,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
118,
119
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 37,
"name": "listUsers",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 61,
"character": 8
}
],
"signatures": [
{
"id": 38,
"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.\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 39,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 40,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 61,
"character": 31
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 41,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 61,
"character": 43
}
],
"type": {
"type": "reference",
"id": 394,
"name": "ApiError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
40,
41
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 42,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 43,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 61,
"character": 65
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 416,
"name": "User"
}
}
},
{
"id": 44,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 61,
"character": 79
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
43,
44
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 169,
"name": "refreshAccessToken",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 447,
"character": 8
}
],
"signatures": [
{
"id": 170,
"name": "refreshAccessToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates a new JWT."
},
"parameters": [
{
"id": 171,
"name": "refreshToken",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid refresh token that was returned on login.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 172,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 173,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 449,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 174,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 449,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
173,
174
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 120,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 304,
"character": 8
}
],
"signatures": [
{
"id": 121,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a reset request to an email address."
},
"parameters": [
{
"id": 122,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 123,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 124,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 125,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 307,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
125
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 126,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 127,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 309,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 128,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 129,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 309,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
127,
129
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 83,
"name": "sendMagicLinkEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 203,
"character": 8
}
],
"signatures": [
{
"id": 84,
"name": "sendMagicLinkEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a magic login link to an email address."
},
"parameters": [
{
"id": 85,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 86,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 87,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 88,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 206,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
88
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 89,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 90,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 208,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 91,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 92,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 208,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
90,
92
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 93,
"name": "sendMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 231,
"character": 8
}
],
"signatures": [
{
"id": 94,
"name": "sendMobileOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a mobile OTP via SMS. Will register the account if it doesn't already exist"
},
"parameters": [
{
"id": 95,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 96,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 97,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 231,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 98,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 99,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 231,
"character": 65
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
97,
99
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 175,
"name": "setAuthCookie",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 469,
"character": 2
}
],
"signatures": [
{
"id": 176,
"name": "setAuthCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Set/delete the auth cookie based on the AuthChangeEvent.\nWorks for Next.js & Express (requires cookie-parser middleware)."
},
"parameters": [
{
"id": 177,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 178,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 56,
"name": "signInWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 116,
"character": 8
}
],
"signatures": [
{
"id": 57,
"name": "signInWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their email address."
},
"parameters": [
{
"id": 58,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 59,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 61,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 62,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 120,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
62
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 63,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 64,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 122,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 65,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 122,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
64,
65
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 76,
"name": "signInWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 177,
"character": 8
}
],
"signatures": [
{
"id": 77,
"name": "signInWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their phone number and password."
},
"parameters": [
{
"id": 78,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 79,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 80,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 81,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 180,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 82,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 180,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
81,
82
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 134,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 343,
"character": 8
}
],
"signatures": [
{
"id": 135,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 136,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 137,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 138,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 343,
"character": 40
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
138
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 45,
"name": "signUpWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 82,
"character": 8
}
],
"signatures": [
{
"id": 46,
"name": "signUpWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user using their email address.",
"returns": "A logged-in session if the server has \"autoconfirm\" ON"
},
"parameters": [
{
"id": 47,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 49,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 50,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 52,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 87,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 51,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 86,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
52,
51
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 53,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 54,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 89,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 55,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 89,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
54,
55
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 66,
"name": "signUpWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 149,
"character": 8
}
],
"signatures": [
{
"id": 67,
"name": "signUpWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Signs up a new user using their phone number and a password."
},
"parameters": [
{
"id": 68,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 69,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 70,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 71,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 72,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 153,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
72
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 73,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 74,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 155,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 75,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 155,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
74,
75
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 153,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 402,
"character": 8
}
],
"signatures": [
{
"id": 154,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 155,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 156,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to update.\n"
},
"type": {
"type": "reference",
"id": 442,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 157,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 159,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 405,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 160,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 405,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 158,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 405,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
159,
160,
158
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 100,
"name": "verifyMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 247,
"character": 8
}
],
"signatures": [
{
"id": 101,
"name": "verifyMobileOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Send User supplied Mobile OTP to be verified"
},
"parameters": [
{
"id": 102,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 103,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "token that user was sent to their mobile phone"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 104,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 105,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 106,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 251,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
106
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 107,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 108,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 253,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 109,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 253,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
108,
109
]
}
]
}
}
],
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
22,
23,
18,
17
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
130,
28,
161,
187,
139,
146,
179,
110,
37,
169,
120,
83,
93,
175,
56,
76,
134,
45,
66,
153,
100
]
}
],
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 8,
"character": 21
}
]
},
{
"id": 199,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 200,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 76,
"character": 2
}
],
"signatures": [
{
"id": 201,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 202,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 203,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 210,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set to \"true\" if you want to automatically refresh the token before expiring."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 80,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 214,
"name": "cookieOptions",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 84,
"character": 4
}
],
"type": {
"type": "reference",
"id": 455,
"name": "CookieOptions"
}
},
{
"id": 209,
"name": "detectSessionInUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 79,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 215,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 85,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 216,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 217,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "A custom fetch implementation.\n"
},
"parameters": [
{
"id": 218,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "RequestInfo"
}
},
{
"id": 219,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "Response"
}
],
"name": "Promise"
}
}
]
}
}
},
{
"id": 205,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Any additional headers to send to the GoTrue server."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 78,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 206,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 207,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 208,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 212,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Provide your own local storage implementation to use instead of the browser's local storage."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 82,
"character": 4
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "Storage"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "getItem"
},
{
"type": "literal",
"value": "setItem"
},
{
"type": "literal",
"value": "removeItem"
}
]
}
],
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 213,
"name": "multiTab",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set to \"false\" if you want to disable multi-tab/window events."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 83,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 211,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set to \"true\" if you want to automatically save the user session into local storage."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 81,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 204,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL of the GoTrue server."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 77,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
210,
214,
209,
215,
205,
212,
213,
211,
204
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 199,
"name": "default"
}
}
]
},
{
"id": 220,
"name": "api",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 47,
"character": 2
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
},
{
"id": 223,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 57,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 222,
"name": "currentSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 55,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 221,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 51,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 225,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 59,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "Storage"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "getItem"
},
{
"type": "literal",
"value": "setItem"
},
{
"type": "literal",
"value": "removeItem"
}
]
}
],
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 226,
"name": "multiTab",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 60,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 224,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 58,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 228,
"name": "refreshTokenTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 62,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Timeout"
}
},
{
"id": 227,
"name": "stateChangeEmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 61,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"id": 447,
"name": "Subscription"
}
],
"name": "Map"
},
"defaultValue": "..."
},
{
"id": 367,
"name": "_callRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 618,
"character": 16
}
],
"signatures": [
{
"id": 368,
"name": "_callRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 369,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 370,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 371,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
},
{
"id": 372,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
371,
372
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 373,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 374,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 375,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 394,
"name": "ApiError"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
374,
375
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 311,
"name": "_handleEmailSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 489,
"character": 16
}
],
"signatures": [
{
"id": 312,
"name": "_handleEmailSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 313,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 314,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 315,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 316,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 317,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 493,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
317
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 318,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 319,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 322,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 321,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 320,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
319,
322,
321,
320
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 323,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 324,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
},
{
"id": 327,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 326,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
},
"defaultValue": "data"
},
{
"id": 325,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
324,
327,
326,
325
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 328,
"name": "_handlePhoneSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 513,
"character": 16
}
],
"signatures": [
{
"id": 329,
"name": "_handlePhoneSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 330,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 331,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 332,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 333,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 336,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 335,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 334,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
333,
336,
335,
334
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 337,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 338,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
},
{
"id": 341,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 340,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
},
"defaultValue": "data"
},
{
"id": 339,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
338,
341,
340,
339
]
}
]
}
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 342,
"name": "_handleProviderSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 529,
"character": 10
}
],
"signatures": [
{
"id": 343,
"name": "_handleProviderSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 344,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 392,
"name": "Provider"
}
},
{
"id": 345,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 346,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 347,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 532,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 348,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 533,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
347,
348
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 349,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 352,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 355,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 350,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 392,
"name": "Provider"
}
},
{
"id": 353,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 351,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 354,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
352,
355,
350,
353,
351,
354
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 356,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 357,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 360,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 394,
"name": "ApiError"
},
"defaultValue": "..."
},
{
"id": 361,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 359,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 362,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 358,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
357,
360,
361,
359,
362,
358
]
}
]
}
}
]
}
}
]
},
{
"id": 390,
"name": "_listenForMultiTabEvents",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 691,
"character": 10
}
],
"signatures": [
{
"id": 391,
"name": "_listenForMultiTabEvents",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Listens for changes to LocalStorage and updates the current session."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "literal",
"value": false
}
]
}
}
]
},
{
"id": 376,
"name": "_notifyAllSubscribers",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 637,
"character": 10
}
],
"signatures": [
{
"id": 377,
"name": "_notifyAllSubscribers",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 378,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 393,
"name": "AuthChangeEvent"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 382,
"name": "_persistSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 664,
"character": 10
}
],
"signatures": [
{
"id": 383,
"name": "_persistSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 384,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 365,
"name": "_recoverAndRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 582,
"character": 16
}
],
"signatures": [
{
"id": 366,
"name": "_recoverAndRefresh",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "literal",
"value": null
}
]
}
],
"name": "Promise"
}
}
]
},
{
"id": 363,
"name": "_recoverSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 558,
"character": 10
}
],
"signatures": [
{
"id": 364,
"name": "_recoverSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Attempts to get the session from LocalStorage\nNote: this should never be async (even for React Native), as we need it to return immediately in the constructor."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "literal",
"value": null
}
]
}
}
]
},
{
"id": 385,
"name": "_removeSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 669,
"character": 16
}
],
"signatures": [
{
"id": 386,
"name": "_removeSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise"
}
}
]
},
{
"id": 379,
"name": "_saveSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 645,
"character": 10
}
],
"signatures": [
{
"id": 380,
"name": "_saveSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible"
},
"parameters": [
{
"id": 381,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 387,
"name": "_startAutoRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 680,
"character": 10
}
],
"signatures": [
{
"id": 388,
"name": "_startAutoRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Clear and re-create refresh token timer"
},
"parameters": [
{
"id": 389,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "time intervals in milliseconds\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 289,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 397,
"character": 8
}
],
"signatures": [
{
"id": 290,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 291,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 292,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 293,
"name": "storeSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optionally store the session in the browser\n"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 398,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
293
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 294,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 295,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 399,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 296,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 399,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
295,
296
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 301,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 469,
"character": 2
}
],
"signatures": [
{
"id": 302,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Receive a notification every time an auth event happens.",
"returns": "A subscription object which can be used to unsubscribe itself.\n"
},
"parameters": [
{
"id": 303,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 304,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 305,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 306,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 393,
"name": "AuthChangeEvent"
}
},
{
"id": 307,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 308,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 309,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 470,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 447,
"name": "Subscription"
}
]
}
},
{
"id": 310,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 471,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
309,
310
]
}
]
}
}
}
]
},
{
"id": 267,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 310,
"character": 8
}
],
"signatures": [
{
"id": 268,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Force refreshes the session including the user data in case it was updated in a different session."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 269,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 270,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 311,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 272,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 313,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 271,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 312,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
270,
272,
271
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 265,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 303,
"character": 2
}
],
"signatures": [
{
"id": 266,
"name": "session",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the session data, if there is an active session."
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
}
]
},
{
"id": 286,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 382,
"character": 2
}
],
"signatures": [
{
"id": 287,
"name": "setAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests."
},
"parameters": [
{
"id": 288,
"name": "access_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "a jwt access token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 397,
"name": "Session"
}
}
]
},
{
"id": 280,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 358,
"character": 8
}
],
"signatures": [
{
"id": 281,
"name": "setSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sets the session data from refresh_token and returns current Session and Error"
},
"parameters": [
{
"id": 282,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "a JWT token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 283,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 285,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 360,
"character": 40
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 284,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 360,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
285,
284
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 240,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 185,
"character": 8
}
],
"signatures": [
{
"id": 241,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 242,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 461,
"name": "UserCredentials"
}
},
{
"id": 243,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 244,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 245,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 188,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 246,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 189,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
245,
246
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 247,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 252,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 196,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 250,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 194,
"character": 4
}
],
"type": {
"type": "reference",
"id": 392,
"name": "Provider"
}
},
{
"id": 248,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 192,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 251,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 195,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 249,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 193,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
252,
250,
248,
251,
249
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 297,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 454,
"character": 8
}
],
"signatures": [
{
"id": 298,
"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\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.",
"text": "For server-side management, you can disable sessions by passing a JWT through to `auth.api.signOut(JWT: string)`\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 299,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 300,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 454,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
300
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 229,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 123,
"character": 8
}
],
"signatures": [
{
"id": 230,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 231,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 461,
"name": "UserCredentials"
}
},
{
"id": 232,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 233,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 235,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 127,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 234,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 126,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
235,
234
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 239,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 132,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 238,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 131,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 237,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 130,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
239,
238,
237
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 273,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 331,
"character": 8
}
],
"signatures": [
{
"id": 274,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 275,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 442,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 276,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 277,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 333,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
},
{
"id": 279,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 333,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 278,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 333,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
277,
279,
278
]
}
]
}
}
],
"name": "Promise"
}
}
]
},
{
"id": 263,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 296,
"character": 2
}
],
"signatures": [
{
"id": 264,
"name": "user",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Inside a browser context, `user()` will return the user data, if there is a logged in user.",
"text": "For server-side management, you can get a user through `auth.api.getUserByCookie()`\n"
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
]
},
{
"id": 253,
"name": "verifyOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 248,
"character": 8
}
],
"signatures": [
{
"id": 254,
"name": "verifyOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in a user given a User supplied OTP received via mobile."
},
"parameters": [
{
"id": 255,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 467,
"name": "VerifyOTPParams"
}
},
{
"id": 256,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 257,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 258,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 251,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
258
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 259,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 262,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 256,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 394,
"name": "ApiError"
}
]
}
},
{
"id": 261,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 255,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
},
{
"id": 260,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 254,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
262,
261,
260
]
}
]
}
}
],
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
200
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
220,
223,
222,
221,
225,
226,
224,
228,
227
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
367,
311,
328,
342,
390,
376,
382,
365,
363,
385,
379,
387,
289,
301,
267,
265,
286,
280,
240,
297,
229,
273,
263,
253
]
}
],
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 42,
"character": 21
}
]
},
{
"id": 394,
"name": "ApiError",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 395,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 396,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
395,
396
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 23,
"character": 17
}
]
},
{
"id": 455,
"name": "CookieOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 458,
"name": "domain",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 123,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 457,
"name": "lifetime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 121,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 456,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 119,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 459,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 124,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 460,
"name": "sameSite",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 126,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
458,
457,
456,
459,
460
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 117,
"character": 17
}
]
},
{
"id": 397,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 399,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 30,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 401,
"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": 38,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 400,
"name": "expires_in",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"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": 34,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 398,
"name": "provider_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 402,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 39,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 403,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 40,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 404,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 41,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 416,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
399,
401,
400,
398,
402,
403,
404
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 17
}
]
},
{
"id": 447,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 448,
"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": 106,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 449,
"name": "callback",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"signatures": [
{
"id": 450,
"name": "callback",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"parameters": [
{
"id": 451,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 393,
"name": "AuthChangeEvent"
}
},
{
"id": 452,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 397,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 453,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 114,
"character": 2
}
],
"signatures": [
{
"id": 454,
"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": [
448
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
449,
453
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 102,
"character": 17
}
]
},
{
"id": 416,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 431,
"name": "action_link",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 69,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 418,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 58,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 419,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 420,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 59,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
420
]
}
],
"indexSignature": {
"id": 421,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 422,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 427,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 65,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 428,
"name": "confirmation_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 66,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 435,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 73,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 434,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 72,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 432,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 70,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 436,
"name": "email_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 74,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 417,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 57,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 441,
"name": "identities",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 79,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 405,
"name": "UserIdentity"
}
}
},
{
"id": 430,
"name": "invited_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 68,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 438,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 76,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 433,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 71,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 437,
"name": "phone_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 75,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 429,
"name": "recovery_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 67,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 439,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 77,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 440,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 78,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 423,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 424,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 425,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 426,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
431,
418,
427,
428,
435,
434,
432,
436,
417,
441,
430,
438,
433,
437,
429,
439,
440,
423
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 56,
"character": 17
}
]
},
{
"id": 442,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 446,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object. Can be any JSON."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 99,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 443,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 445,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 94,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 444,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
446,
443,
445,
444
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 17
}
]
},
{
"id": 461,
"name": "UserCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 462,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 130,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 464,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 132,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 463,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 131,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 466,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 135,
"character": 2
}
],
"type": {
"type": "reference",
"id": 392,
"name": "Provider"
}
},
{
"id": 465,
"name": "refreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 133,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
462,
464,
463,
466,
465
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 129,
"character": 17
}
]
},
{
"id": 405,
"name": "UserIdentity",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 413,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 51,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 406,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 408,
"name": "identity_data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 47,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 409,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 410,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 411,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 414,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 412,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 415,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 53,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 407,
"name": "user_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 46,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
413,
406,
408,
414,
412,
415,
407
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 44,
"character": 17
}
]
},
{
"id": 467,
"name": "VerifyOTPParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 468,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 139,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 469,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 140,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
468,
469
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 138,
"character": 17
}
]
},
{
"id": 393,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "PASSWORD_RECOVERY"
},
{
"type": "literal",
"value": "SIGNED_IN"
},
{
"type": "literal",
"value": "SIGNED_OUT"
},
{
"type": "literal",
"value": "TOKEN_REFRESHED"
},
{
"type": "literal",
"value": "USER_UPDATED"
},
{
"type": "literal",
"value": "USER_DELETED"
}
]
}
},
{
"id": 392,
"name": "Provider",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "azure"
},
{
"type": "literal",
"value": "bitbucket"
},
{
"type": "literal",
"value": "facebook"
},
{
"type": "literal",
"value": "github"
},
{
"type": "literal",
"value": "gitlab"
},
{
"type": "literal",
"value": "google"
},
{
"type": "literal",
"value": "twitter"
},
{
"type": "literal",
"value": "apple"
},
{
"type": "literal",
"value": "discord"
},
{
"type": "literal",
"value": "twitch"
},
{
"type": "literal",
"value": "spotify"
},
{
"type": "literal",
"value": "slack"
}
]
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
1,
199
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
394,
455,
397,
447,
416,
442,
461,
405,
467
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
393,
392
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
}
Reference in new issue View Git Blame Copy Permalink