lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-07-06 23:34:22 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
7ed284fb7baaba27afa19fca92edc5e79dfd63ca
supabase/web/spec/gotrue.json
thorwebdev 5abe43e5fe chore: update clients list with functions clients.
2022-04-04 14:55:42 +08:00

11234 lines
243 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": 25,
"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": 35,
"character": 4
}
],
"type": {
"type": "reference",
"id": 532,
"name": "CookieOptions"
}
},
{
"id": 12,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 36,
"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",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 16,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 7,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 32,
"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": 31,
"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": 22,
"character": 12
}
],
"type": {
"type": "reference",
"id": 532,
"name": "CookieOptions"
}
},
{
"id": 23,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 23,
"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",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 27,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 18,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 19,
"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": 18,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 28,
"name": "_createRequestHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 49,
"character": 10
}
],
"signatures": [
{
"id": 29,
"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": 30,
"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": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
}
]
},
{
"id": 32,
"name": "cookieName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 55,
"character": 10
}
],
"signatures": [
{
"id": 33,
"name": "cookieName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 188,
"name": "createUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 637,
"character": 8
}
],
"signatures": [
{
"id": 189,
"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": 190,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to create the user with.\n"
},
"type": {
"type": "reference",
"id": 514,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 191,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 193,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 18
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 194,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 30
}
],
"type": {
"type": "reference",
"id": 460,
"name": "ApiError"
}
},
{
"id": 192,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
193,
194,
192
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 195,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 197,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 64
}
],
"type": {
"type": "reference",
"id": 482,
"name": "User"
}
},
{
"id": 198,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 76
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 196,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 640,
"character": 52
}
],
"type": {
"type": "reference",
"id": 482,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
197,
198,
196
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 165,
"name": "deleteAuthCookie",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 533,
"character": 2
}
],
"signatures": [
{
"id": 166,
"name": "deleteAuthCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes the Auth Cookies and redirects to the"
},
"parameters": [
{
"id": 167,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The request object."
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 168,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The response object."
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 169,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Optionally specify a `redirectTo` URL in the options.\n"
},
"originalName": "__namedParameters",
"type": {
"type": "reflection",
"declaration": {
"id": 170,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 171,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 533,
"character": 63
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
171
]
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
},
{
"id": 233,
"name": "deleteUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 777,
"character": 8
}
],
"signatures": [
{
"id": 234,
"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": 235,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user uid you want to remove.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 238,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 779,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 239,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 779,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 237,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 779,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
238,
239,
237
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 176,
"name": "generateLink",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 600,
"character": 8
}
],
"signatures": [
{
"id": 177,
"name": "generateLink",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates links to be sent via email or other."
},
"parameters": [
{
"id": 178,
"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": 179,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's email."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 180,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 181,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 183,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 605,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 182,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 604,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 184,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 606,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
183,
182,
184
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 186,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 608,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 187,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 608,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
186,
187
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 172,
"name": "getAuthCookieString",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 552,
"character": 2
}
],
"signatures": [
{
"id": 173,
"name": "getAuthCookieString",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Helper method to generate the Auth Cookie string for you in case you can't use `setAuthCookie`.",
"returns": "The Cookie string that needs to be set as the value for the `Set-Cookie` header.\n"
},
"parameters": [
{
"id": 174,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The request object."
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 175,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The response object."
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
]
},
{
"id": 34,
"name": "getUrlForProvider",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 65,
"character": 2
}
],
"signatures": [
{
"id": 35,
"name": "getUrlForProvider",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates the relevant login URL for a third-party provider."
},
"parameters": [
{
"id": 36,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "One of the providers supported by GoTrue."
},
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
},
{
"id": 37,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 38,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 39,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 68,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 40,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 69,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
39,
40
]
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 240,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 804,
"character": 8
}
],
"signatures": [
{
"id": 241,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the current user details.",
"text": "This method is called by the GoTrueClient `update` where\nthe jwt is set to this.currentSession.access_token\nand therefore, acts like getting the currently authenticated used\n"
},
"parameters": [
{
"id": 242,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT. Typically, the access_token for the currentSession\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 243,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 245,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 806,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 246,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 806,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 244,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 806,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
245,
246,
244
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 216,
"name": "getUserByCookie",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 692,
"character": 8
}
],
"signatures": [
{
"id": 217,
"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": 218,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 219,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 220,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 223,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 698,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 224,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 699,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 221,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 696,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 222,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 697,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
223,
224,
221,
222
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 207,
"name": "getUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 675,
"character": 8
}
],
"signatures": [
{
"id": 208,
"name": "getUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Get user by id."
},
"parameters": [
{
"id": 209,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 210,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 211,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 677,
"character": 15
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 212,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 677,
"character": 27
}
],
"type": {
"type": "reference",
"id": 460,
"name": "ApiError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
211,
212
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 213,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 214,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 677,
"character": 49
}
],
"type": {
"type": "reference",
"id": 482,
"name": "User"
}
},
{
"id": 215,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 677,
"character": 61
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
214,
215
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 134,
"name": "inviteUserByEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 404,
"character": 8
}
],
"signatures": [
{
"id": 135,
"name": "inviteUserByEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends an invite link to an email address."
},
"parameters": [
{
"id": 136,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 137,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 138,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 140,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 408,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 139,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 407,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
140,
139
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 141,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 142,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 410,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 143,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 410,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
142,
143
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 199,
"name": "listUsers",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 657,
"character": 8
}
],
"signatures": [
{
"id": 200,
"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": 201,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 202,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 657,
"character": 31
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 203,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 657,
"character": 43
}
],
"type": {
"type": "reference",
"id": 460,
"name": "ApiError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
202,
203
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 204,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 205,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 657,
"character": 65
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 482,
"name": "User"
}
}
},
{
"id": 206,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 657,
"character": 79
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
205,
206
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 155,
"name": "refreshAccessToken",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 463,
"character": 8
}
],
"signatures": [
{
"id": 156,
"name": "refreshAccessToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates a new JWT."
},
"parameters": [
{
"id": 157,
"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": 158,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 159,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 465,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 160,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 465,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
159,
160
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 144,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 434,
"character": 8
}
],
"signatures": [
{
"id": 145,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a reset request to an email address."
},
"parameters": [
{
"id": 146,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 147,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 148,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 150,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 438,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 149,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 437,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
150,
149
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 151,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 152,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 440,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 153,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 154,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 440,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
152,
154
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 87,
"name": "sendMagicLinkEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 258,
"character": 8
}
],
"signatures": [
{
"id": 88,
"name": "sendMagicLinkEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a magic login link to an email address."
},
"parameters": [
{
"id": 89,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 90,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 91,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 94,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 263,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 93,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 262,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 92,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 261,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
94,
93,
92
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 95,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 96,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 265,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 97,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 98,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 265,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
96,
98
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 99,
"name": "sendMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 295,
"character": 8
}
],
"signatures": [
{
"id": 100,
"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": 101,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 102,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 103,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 105,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 299,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 104,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 298,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
105,
104
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 106,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 107,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 301,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
]
}
},
{
"id": 109,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 301,
"character": 32
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
107,
109
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 161,
"name": "setAuthCookie",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 487,
"character": 2
}
],
"signatures": [
{
"id": 162,
"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": 163,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The request object."
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 164,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The response object.\n"
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 53,
"name": "signInWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 132,
"character": 8
}
],
"signatures": [
{
"id": 54,
"name": "signInWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their email address."
},
"parameters": [
{
"id": 55,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 56,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 57,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 58,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 59,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 136,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
59
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 60,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 61,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 138,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 62,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 138,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
61,
62
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 81,
"name": "signInWithOpenIDConnect",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 228,
"character": 8
}
],
"signatures": [
{
"id": 82,
"name": "signInWithOpenIDConnect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an OpenID Connect user using their id_token."
},
"parameters": [
{
"id": 83,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 558,
"name": "OpenIDConnectCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 84,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 85,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 234,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 86,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 234,
"character": 64
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
85,
86
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 74,
"name": "signInWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 199,
"character": 8
}
],
"signatures": [
{
"id": 75,
"name": "signInWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their phone number and password."
},
"parameters": [
{
"id": 76,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 77,
"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": 78,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 79,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 202,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 80,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 202,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
79,
80
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 110,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 325,
"character": 8
}
],
"signatures": [
{
"id": 111,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 112,
"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": 113,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 114,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 325,
"character": 40
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
114
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 41,
"name": "signUpWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 92,
"character": 8
}
],
"signatures": [
{
"id": 42,
"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": 43,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 44,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 45,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 46,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 49,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 98,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 97,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 47,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 96,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
49,
48,
47
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 50,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 51,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 100,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 52,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 100,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
51,
52
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 63,
"name": "signUpWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 165,
"character": 8
}
],
"signatures": [
{
"id": 64,
"name": "signUpWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Signs up a new user using their phone number and a password."
},
"parameters": [
{
"id": 65,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 66,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 67,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 68,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 70,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 170,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 69,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 169,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
70,
69
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 71,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 72,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 172,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 73,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 172,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
72,
73
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 247,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 822,
"character": 8
}
],
"signatures": [
{
"id": 248,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 249,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 250,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to update.\n"
},
"type": {
"type": "reference",
"id": 508,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 251,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 253,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 825,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 254,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 825,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 252,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 825,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
253,
254,
252
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 225,
"name": "updateUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 755,
"character": 8
}
],
"signatures": [
{
"id": 226,
"name": "updateUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 227,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 228,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n"
},
"type": {
"type": "reference",
"id": 514,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 229,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 231,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 758,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 232,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 758,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 230,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 758,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
231,
232,
230
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 115,
"name": "verifyMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 345,
"character": 8
}
],
"signatures": [
{
"id": 116,
"name": "verifyMobileOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `verifyOTP` instead!"
}
]
},
"parameters": [
{
"id": 117,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 118,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "token that user was sent to their mobile phone"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 119,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 120,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 121,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 349,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
121
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 122,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 123,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 351,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 124,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 351,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
123,
124
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 125,
"name": "verifyOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 376,
"character": 8
}
],
"signatures": [
{
"id": 126,
"name": "verifyOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Send User supplied Email / Mobile OTP to be verified"
},
"parameters": [
{
"id": 127,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 545,
"name": "VerifyOTPParams"
}
},
{
"id": 128,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 129,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 130,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 379,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
130
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 131,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 132,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 381,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 133,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 381,
"character": 44
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
132,
133
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
22,
23,
18,
17
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
28,
32,
188,
165,
233,
176,
172,
34,
240,
216,
207,
134,
199,
155,
144,
87,
99,
161,
53,
81,
74,
110,
41,
63,
247,
225,
115,
125
]
}
],
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 17,
"character": 21
}
]
},
{
"id": 255,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 256,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 77,
"character": 2
}
],
"signatures": [
{
"id": 257,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 258,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 259,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 266,
"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": 81,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 270,
"name": "cookieOptions",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 85,
"character": 4
}
],
"type": {
"type": "reference",
"id": 532,
"name": "CookieOptions"
}
},
{
"id": 265,
"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": 80,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 271,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 86,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 272,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 273,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "A custom fetch implementation.\n"
},
"parameters": [
{
"id": 274,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 275,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 261,
"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": 79,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 263,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 264,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 268,
"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": 83,
"character": 4
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Storage",
"package": "typescript",
"name": "Storage"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "getItem"
},
{
"type": "literal",
"value": "setItem"
},
{
"type": "literal",
"value": "removeItem"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 269,
"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": 84,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 267,
"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": 82,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 260,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL of the GoTrue server."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 78,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
266,
270,
265,
271,
261,
268,
269,
267,
260
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 255,
"name": "default"
}
}
]
},
{
"id": 276,
"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": 48,
"character": 2
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
},
{
"id": 279,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 58,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 278,
"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": 56,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 277,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 52,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 281,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 60,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Storage",
"package": "typescript",
"name": "Storage"
},
{
"type": "union",
"types": [
{
"type": "literal",
"value": "getItem"
},
{
"type": "literal",
"value": "setItem"
},
{
"type": "literal",
"value": "removeItem"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 282,
"name": "multiTab",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 61,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 280,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 59,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 284,
"name": "refreshTokenTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 63,
"character": 12
}
],
"type": {
"type": "reference",
"qualifiedName": "NodeJS.Timeout",
"package": "@types/node",
"name": "Timeout"
}
},
{
"id": 283,
"name": "stateChangeEmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 62,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"id": 524,
"name": "Subscription"
}
],
"qualifiedName": "Map",
"package": "typescript",
"name": "Map"
},
"defaultValue": "..."
},
{
"id": 433,
"name": "_callRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 669,
"character": 16
}
],
"signatures": [
{
"id": 434,
"name": "_callRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 435,
"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": 436,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 437,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
},
{
"id": 438,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
437,
438
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 439,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 440,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 441,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 460,
"name": "ApiError"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
440,
441
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 370,
"name": "_handleEmailSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 509,
"character": 16
}
],
"signatures": [
{
"id": 371,
"name": "_handleEmailSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 372,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 373,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 374,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 375,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 376,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 513,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
376
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 377,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 378,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 381,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 380,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 379,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
378,
381,
380,
379
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 382,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 383,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
},
{
"id": 386,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 385,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
},
"defaultValue": "data"
},
{
"id": 384,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
383,
386,
385,
384
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 422,
"name": "_handleOpenIDConnectSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 574,
"character": 16
}
],
"signatures": [
{
"id": 423,
"name": "_handleOpenIDConnectSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 424,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 558,
"name": "OpenIDConnectCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 425,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 428,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 583,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 426,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 581,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 427,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 582,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
428,
426,
427
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 387,
"name": "_handlePhoneSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 533,
"character": 16
}
],
"signatures": [
{
"id": 388,
"name": "_handlePhoneSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 389,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 390,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 391,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 392,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 395,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 394,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 393,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
392,
395,
394,
393
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 396,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 397,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
},
{
"id": 400,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 399,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
},
"defaultValue": "data"
},
{
"id": 398,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
397,
400,
399,
398
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 401,
"name": "_handleProviderSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 549,
"character": 10
}
],
"signatures": [
{
"id": 402,
"name": "_handleProviderSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 403,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
},
{
"id": 404,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 405,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 406,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 552,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 407,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 553,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
406,
407
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 408,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 411,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 414,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 409,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
},
{
"id": 412,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 410,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 413,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
411,
414,
409,
412,
410,
413
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 415,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 416,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 419,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 460,
"name": "ApiError"
},
"defaultValue": "..."
},
{
"id": 420,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 418,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 421,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 417,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
416,
419,
420,
418,
421,
417
]
}
]
}
}
]
}
}
]
},
{
"id": 456,
"name": "_listenForMultiTabEvents",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 742,
"character": 10
}
],
"signatures": [
{
"id": 457,
"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": 442,
"name": "_notifyAllSubscribers",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 688,
"character": 10
}
],
"signatures": [
{
"id": 443,
"name": "_notifyAllSubscribers",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 444,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 459,
"name": "AuthChangeEvent"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 448,
"name": "_persistSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 715,
"character": 10
}
],
"signatures": [
{
"id": 449,
"name": "_persistSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 450,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 431,
"name": "_recoverAndRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 633,
"character": 16
}
],
"signatures": [
{
"id": 432,
"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
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 429,
"name": "_recoverSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 609,
"character": 10
}
],
"signatures": [
{
"id": 430,
"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": 451,
"name": "_removeSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 720,
"character": 16
}
],
"signatures": [
{
"id": 452,
"name": "_removeSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 445,
"name": "_saveSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 696,
"character": 10
}
],
"signatures": [
{
"id": 446,
"name": "_saveSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible"
},
"parameters": [
{
"id": 447,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 453,
"name": "_startAutoRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 731,
"character": 10
}
],
"signatures": [
{
"id": 454,
"name": "_startAutoRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Clear and re-create refresh token timer"
},
"parameters": [
{
"id": 455,
"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": 348,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 417,
"character": 8
}
],
"signatures": [
{
"id": 349,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 350,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 351,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 352,
"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": 418,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
352
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 353,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 354,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 419,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 355,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 419,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
354,
355
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 360,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 489,
"character": 2
}
],
"signatures": [
{
"id": 361,
"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": 362,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 363,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 364,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 365,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 459,
"name": "AuthChangeEvent"
}
},
{
"id": 366,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 367,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 368,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 490,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 524,
"name": "Subscription"
}
]
}
},
{
"id": 369,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 491,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
368,
369
]
}
]
}
}
}
]
},
{
"id": 326,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 330,
"character": 8
}
],
"signatures": [
{
"id": 327,
"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": 328,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 329,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 331,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 331,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 333,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 330,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 332,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
329,
331,
330
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 324,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 323,
"character": 2
}
],
"signatures": [
{
"id": 325,
"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": 463,
"name": "Session"
}
]
}
}
]
},
{
"id": 345,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 402,
"character": 2
}
],
"signatures": [
{
"id": 346,
"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": 347,
"name": "access_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "a jwt access token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 463,
"name": "Session"
}
}
]
},
{
"id": 339,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 378,
"character": 8
}
],
"signatures": [
{
"id": 340,
"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": 341,
"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": 342,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 344,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 380,
"character": 40
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 343,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 380,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
344,
343
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 297,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 191,
"character": 8
}
],
"signatures": [
{
"id": 298,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 299,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 538,
"name": "UserCredentials"
}
},
{
"id": 300,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 301,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 305,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 197,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 302,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 194,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 304,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 196,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 303,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 195,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
305,
302,
304,
303
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 306,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 311,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 204,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 309,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 202,
"character": 4
}
],
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
},
{
"id": 307,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 200,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 310,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 203,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 308,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 201,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
311,
309,
307,
310,
308
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 356,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 474,
"character": 8
}
],
"signatures": [
{
"id": 357,
"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": 358,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 359,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 474,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
359
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 285,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 124,
"character": 8
}
],
"signatures": [
{
"id": 286,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 287,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 538,
"name": "UserCredentials"
}
},
{
"id": 288,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 289,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 292,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 129,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 291,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 128,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 290,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 127,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
292,
291,
290
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 293,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 296,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 134,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 295,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 133,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 294,
"name": "user",
"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": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
296,
295,
294
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 332,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 351,
"character": 8
}
],
"signatures": [
{
"id": 333,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 334,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 508,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 335,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 336,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 353,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
},
{
"id": 338,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 353,
"character": 53
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 337,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 353,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
336,
338,
337
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 322,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 316,
"character": 2
}
],
"signatures": [
{
"id": 323,
"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": 482,
"name": "User"
}
]
}
}
]
},
{
"id": 312,
"name": "verifyOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 268,
"character": 8
}
],
"signatures": [
{
"id": 313,
"name": "verifyOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in a user given a User supplied OTP received via mobile."
},
"parameters": [
{
"id": 314,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 545,
"name": "VerifyOTPParams"
}
},
{
"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": 271,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
317
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 318,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 321,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 276,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 460,
"name": "ApiError"
}
]
}
},
{
"id": 320,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 275,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
},
{
"id": 319,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 274,
"character": 4
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
321,
320,
319
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
256
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
276,
279,
278,
277,
281,
282,
280,
284,
283
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
433,
370,
422,
387,
401,
456,
442,
448,
431,
429,
451,
445,
453,
348,
360,
326,
324,
345,
339,
297,
356,
285,
332,
322,
312
]
}
],
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 43,
"character": 21
}
]
},
{
"id": 514,
"name": "AdminUserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 516,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object for app_metadata that.",
"text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 135,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 523,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
},
"inheritedFrom": {
"type": "reference",
"id": 513,
"name": "UserAttributes.data"
}
},
{
"id": 519,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 509,
"name": "UserAttributes.email"
}
},
{
"id": 522,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 105,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 512,
"name": "UserAttributes.email_change_token"
}
},
{
"id": 517,
"name": "email_confirm",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Sets if a user has confirmed their email address.",
"text": "Only a service role can modify.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 142,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 521,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 100,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 511,
"name": "UserAttributes.password"
}
},
{
"id": 520,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 95,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 510,
"name": "UserAttributes.phone"
}
},
{
"id": 518,
"name": "phone_confirm",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Sets if a user has confirmed their phone number.",
"text": "Only a service role can modify.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 149,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 515,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object for user_metadata.",
"text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 125,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
516,
523,
519,
522,
517,
521,
520,
518,
515
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 113,
"character": 17
}
],
"extendedTypes": [
{
"type": "reference",
"id": 508,
"name": "UserAttributes"
}
]
},
{
"id": 460,
"name": "ApiError",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 461,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 462,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
461,
462
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 27,
"character": 17
}
]
},
{
"id": 532,
"name": "CookieOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 535,
"name": "domain",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 173,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 534,
"name": "lifetime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 171,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 533,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 169,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 536,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 174,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 537,
"name": "sameSite",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 176,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
535,
534,
533,
536,
537
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 167,
"character": 17
}
]
},
{
"id": 558,
"name": "OpenIDConnectCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 562,
"name": "client_id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 209,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 559,
"name": "id_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 206,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 563,
"name": "issuer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 210,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 560,
"name": "nonce",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 207,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 561,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 208,
"character": 2
}
],
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
562,
559,
563,
560,
561
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 205,
"character": 17
}
]
},
{
"id": 463,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 465,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 34,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 467,
"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": 42,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 466,
"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": 38,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 464,
"name": "provider_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 468,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 469,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 470,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 482,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
465,
467,
466,
464,
468,
469,
470
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 32,
"character": 17
}
]
},
{
"id": 524,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 525,
"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": 156,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 526,
"name": "callback",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 160,
"character": 2
}
],
"signatures": [
{
"id": 527,
"name": "callback",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"parameters": [
{
"id": 528,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 459,
"name": "AuthChangeEvent"
}
},
{
"id": 529,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 463,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 530,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 164,
"character": 2
}
],
"signatures": [
{
"id": 531,
"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": [
525
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
526,
530
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 152,
"character": 17
}
]
},
{
"id": 482,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 497,
"name": "action_link",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 73,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 484,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 485,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 486,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 63,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
486
]
}
],
"indexSignature": {
"id": 487,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 488,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 493,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 69,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 494,
"name": "confirmation_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 70,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 501,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 77,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 500,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 76,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 498,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 74,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 502,
"name": "email_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 78,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 483,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 61,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 507,
"name": "identities",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 83,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 471,
"name": "UserIdentity"
}
}
},
{
"id": 496,
"name": "invited_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 72,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 504,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 80,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 499,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 75,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 503,
"name": "phone_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 79,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 495,
"name": "recovery_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 71,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 505,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 81,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 506,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 489,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 66,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 490,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 491,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 492,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
497,
484,
493,
494,
501,
500,
498,
502,
483,
507,
496,
504,
499,
503,
495,
505,
506,
489
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 60,
"character": 17
}
]
},
{
"id": 508,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 513,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 509,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 512,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 105,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 511,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 100,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 510,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 95,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
513,
509,
512,
511,
510
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 17
}
],
"extendedBy": [
{
"type": "reference",
"id": 514,
"name": "AdminUserAttributes"
}
]
},
{
"id": 538,
"name": "UserCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 539,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 180,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 544,
"name": "oidc",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 186,
"character": 2
}
],
"type": {
"type": "reference",
"id": 558,
"name": "OpenIDConnectCredentials"
}
},
{
"id": 541,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 182,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 540,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 181,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 543,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 185,
"character": 2
}
],
"type": {
"type": "reference",
"id": 458,
"name": "Provider"
}
},
{
"id": 542,
"name": "refreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 183,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
539,
544,
541,
540,
543,
542
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 179,
"character": 17
}
]
},
{
"id": 471,
"name": "UserIdentity",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 479,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 55,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 472,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 49,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 474,
"name": "identity_data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 51,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 475,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 476,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 477,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 480,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 56,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 478,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 481,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 57,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 473,
"name": "user_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 50,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
479,
472,
474,
480,
478,
481,
473
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 48,
"character": 17
}
]
},
{
"id": 551,
"name": "VerifyEmailOTPParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 552,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 197,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 553,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 198,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 554,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 199,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 555,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 200,
"character": 2
}
],
"type": {
"type": "reference",
"id": 557,
"name": "EmailOTPType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
552,
553,
554,
555
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 196,
"character": 17
}
]
},
{
"id": 546,
"name": "VerifyMobileOTPParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 547,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 191,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 548,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 192,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 549,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 193,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 550,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 194,
"character": 2
}
],
"type": {
"type": "reference",
"id": 556,
"name": "MobileOTPType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
547,
548,
549,
550
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 190,
"character": 17
}
]
},
{
"id": 459,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 19,
"character": 12
}
],
"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": 557,
"name": "EmailOTPType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 203,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "signup"
},
{
"type": "literal",
"value": "invite"
},
{
"type": "literal",
"value": "magiclink"
},
{
"type": "literal",
"value": "recovery"
},
{
"type": "literal",
"value": "email_change"
}
]
}
},
{
"id": 556,
"name": "MobileOTPType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 202,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "phone_change"
}
]
}
},
{
"id": 458,
"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": "apple"
},
{
"type": "literal",
"value": "azure"
},
{
"type": "literal",
"value": "bitbucket"
},
{
"type": "literal",
"value": "discord"
},
{
"type": "literal",
"value": "facebook"
},
{
"type": "literal",
"value": "github"
},
{
"type": "literal",
"value": "gitlab"
},
{
"type": "literal",
"value": "google"
},
{
"type": "literal",
"value": "keycloak"
},
{
"type": "literal",
"value": "linkedin"
},
{
"type": "literal",
"value": "notion"
},
{
"type": "literal",
"value": "slack"
},
{
"type": "literal",
"value": "spotify"
},
{
"type": "literal",
"value": "twitch"
},
{
"type": "literal",
"value": "twitter"
},
{
"type": "literal",
"value": "workos"
}
]
}
},
{
"id": 545,
"name": "VerifyOTPParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 189,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 546,
"name": "VerifyMobileOTPParams"
},
{
"type": "reference",
"id": 551,
"name": "VerifyEmailOTPParams"
}
]
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
1,
255
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
514,
460,
532,
558,
463,
524,
482,
508,
538,
471,
551,
546
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
459,
557,
556,
458,
545
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
}
Reference in New Issue View Git Blame Copy Permalink