Files
supabase/web/spec/tsdoc_v2/gotrue.json
T
Inian ae26e66e96 add individual specs for v2
all generated via typedoc v0.22.16
2022-08-15 19:18:36 +08:00

14815 lines
322 KiB
JSON

{
"id": 0,
"name": "@supabase/gotrue-js",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 675,
"name": "AuthApiError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 676,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 17,
"character": 2
}
],
"signatures": [
{
"id": 677,
"name": "new AuthApiError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 678,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 679,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 675,
"name": "AuthApiError"
},
"overwrites": {
"type": "reference",
"id": 672,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 671,
"name": "AuthError.constructor"
}
},
{
"id": 687,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 674,
"name": "AuthError.__isAuthError"
}
},
{
"id": 680,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 681,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 23,
"character": 2
}
],
"signatures": [
{
"id": 682,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 683,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 685,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 26,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 684,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 25,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 686,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 27,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
685,
684,
686
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
676
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
687,
680
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
681
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 14,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 670,
"name": "AuthError"
}
]
},
{
"id": 670,
"name": "AuthError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 671,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 4,
"character": 2
}
],
"signatures": [
{
"id": 672,
"name": "new AuthError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 673,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
},
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
},
{
"id": 674,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
671
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
674
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 1,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"qualifiedName": "Error",
"package": "typescript",
"name": "Error"
}
],
"extendedBy": [
{
"type": "reference",
"id": 675,
"name": "AuthApiError"
},
{
"type": "reference",
"id": 688,
"name": "AuthUnknownError"
},
{
"type": "reference",
"id": 695,
"name": "CustomAuthError"
}
]
},
{
"id": 722,
"name": "AuthInvalidCredentialsError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 723,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 67,
"character": 2
}
],
"signatures": [
{
"id": 724,
"name": "new AuthInvalidCredentialsError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 725,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 722,
"name": "AuthInvalidCredentialsError"
},
"overwrites": {
"type": "reference",
"id": 697,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 696,
"name": "CustomAuthError.constructor"
}
},
{
"id": 734,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 709,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 726,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 701,
"name": "CustomAuthError.name"
}
},
{
"id": 727,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 702,
"name": "CustomAuthError.status"
}
},
{
"id": 728,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 51,
"character": 2
}
],
"signatures": [
{
"id": 729,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 730,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 732,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 54,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 731,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 53,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 733,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 55,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
732,
731,
733
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 704,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 703,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
723
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
734,
726,
727
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
728
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 66,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 695,
"name": "CustomAuthError"
}
]
},
{
"id": 735,
"name": "AuthRetryableFetchError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 736,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 73,
"character": 2
}
],
"signatures": [
{
"id": 737,
"name": "new AuthRetryableFetchError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 738,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 739,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 735,
"name": "AuthRetryableFetchError"
},
"overwrites": {
"type": "reference",
"id": 697,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 696,
"name": "CustomAuthError.constructor"
}
},
{
"id": 748,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 709,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 740,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 701,
"name": "CustomAuthError.name"
}
},
{
"id": 741,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 702,
"name": "CustomAuthError.status"
}
},
{
"id": 742,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 51,
"character": 2
}
],
"signatures": [
{
"id": 743,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 744,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 746,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 54,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 745,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 53,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 747,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 55,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
746,
745,
747
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 704,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 703,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
736
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
748,
740,
741
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
742
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 72,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 695,
"name": "CustomAuthError"
}
]
},
{
"id": 710,
"name": "AuthSessionMissingError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 711,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 61,
"character": 2
}
],
"signatures": [
{
"id": 712,
"name": "new AuthSessionMissingError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"type": {
"type": "reference",
"id": 710,
"name": "AuthSessionMissingError"
},
"overwrites": {
"type": "reference",
"id": 697,
"name": "CustomAuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 696,
"name": "CustomAuthError.constructor"
}
},
{
"id": 721,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 709,
"name": "CustomAuthError.__isAuthError"
}
},
{
"id": 713,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 701,
"name": "CustomAuthError.name"
}
},
{
"id": 714,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 702,
"name": "CustomAuthError.status"
}
},
{
"id": 715,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 51,
"character": 2
}
],
"signatures": [
{
"id": 716,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 717,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 719,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 54,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 718,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 53,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 720,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 55,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
719,
718,
720
]
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 704,
"name": "CustomAuthError.toJSON"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 703,
"name": "CustomAuthError.toJSON"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
711
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
721,
713,
714
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
715
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 60,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 695,
"name": "CustomAuthError"
}
]
},
{
"id": 688,
"name": "AuthUnknownError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 689,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 35,
"character": 2
}
],
"signatures": [
{
"id": 690,
"name": "new AuthUnknownError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 691,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 692,
"name": "originalError",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"id": 688,
"name": "AuthUnknownError"
},
"overwrites": {
"type": "reference",
"id": 672,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 671,
"name": "AuthError.constructor"
}
},
{
"id": 694,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 674,
"name": "AuthError.__isAuthError"
}
},
{
"id": 693,
"name": "originalError",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
689
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
694,
693
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 32,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 670,
"name": "AuthError"
}
]
},
{
"id": 695,
"name": "CustomAuthError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 696,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 45,
"character": 2
}
],
"signatures": [
{
"id": 697,
"name": "new CustomAuthError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 698,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 699,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 700,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 695,
"name": "CustomAuthError"
},
"overwrites": {
"type": "reference",
"id": 672,
"name": "AuthError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 671,
"name": "AuthError.constructor"
}
},
{
"id": 709,
"name": "__isAuthError",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 2,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true",
"inheritedFrom": {
"type": "reference",
"id": 674,
"name": "AuthError.__isAuthError"
}
},
{
"id": 701,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 43,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"overwrites": {
"type": "reference",
"name": "AuthError.name"
}
},
{
"id": 702,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 44,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 703,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 51,
"character": 2
}
],
"signatures": [
{
"id": 704,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 705,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 707,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 54,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 706,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 53,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 708,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 55,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
707,
706,
708
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
696
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
709,
701,
702
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
703
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 42,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 670,
"name": "AuthError"
}
],
"extendedBy": [
{
"type": "reference",
"id": 710,
"name": "AuthSessionMissingError"
},
{
"type": "reference",
"id": 722,
"name": "AuthInvalidCredentialsError"
},
{
"type": "reference",
"id": 735,
"name": "AuthRetryableFetchError"
}
]
},
{
"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": 21,
"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": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 30,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 12,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 13,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 14,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 15,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 7,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 27,
"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": 26,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
11,
7,
6
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
}
]
},
{
"id": 21,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 19,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 22,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 23,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 24,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 25,
"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": 17,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 16,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 18,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 19,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 20,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 16,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 15,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 26,
"name": "_createRequestHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 42,
"character": 10
}
],
"signatures": [
{
"id": 27,
"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": 28,
"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": 29,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
}
]
},
{
"id": 230,
"name": "createUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 669,
"character": 8
}
],
"signatures": [
{
"id": 231,
"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": 232,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to create the user with.\n"
},
"type": {
"type": "reference",
"id": 582,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 233,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 235,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 18
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 236,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 30
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 234,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 6
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
235,
236,
234
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 237,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 239,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 60
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 240,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 72
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 238,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 672,
"character": 48
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
239,
240,
238
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 268,
"name": "deleteUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 771,
"character": 8
}
],
"signatures": [
{
"id": 269,
"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": 270,
"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": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 271,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 273,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 774,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 272,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 773,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
273,
272
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 274,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 276,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 776,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 275,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 776,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
276,
275
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 212,
"name": "generateLink",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 618,
"character": 8
}
],
"signatures": [
{
"id": 213,
"name": "generateLink",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates links to be sent via email or other."
},
"parameters": [
{
"id": 214,
"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": "invite"
},
{
"type": "literal",
"value": "magiclink"
},
{
"type": "literal",
"value": "recovery"
}
]
}
},
{
"id": 215,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's email."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 216,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 217,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 219,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional user metadata. For signup only."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 623,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 218,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "User password. For signup only."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 622,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 220,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\").\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 624,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
219,
218,
220
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 221,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 222,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 628,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 223,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 629,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
222,
223
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 224,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 225,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 632,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 226,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 633,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
225,
226
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 227,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 228,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 635,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 229,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 635,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
228,
229
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 30,
"name": "getUrlForProvider",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 54,
"character": 2
}
],
"signatures": [
{
"id": 31,
"name": "getUrlForProvider",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates the relevant login URL for a third-party provider."
},
"parameters": [
{
"id": 32,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "One of the providers supported by GoTrue."
},
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 33,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 34,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 37,
"name": "queryParams",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 59,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 38,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 39,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 40,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 35,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 57,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 36,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A space-separated list of scopes granted to the OAuth application.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 58,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
37,
35,
36
]
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
},
{
"id": 277,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 806,
"character": 8
}
],
"signatures": [
{
"id": 278,
"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 user\n"
},
"parameters": [
{
"id": 279,
"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": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 280,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 282,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 809,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 281,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 808,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
282,
281
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 283,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 285,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 811,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 284,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 811,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
285,
284
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 249,
"name": "getUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 715,
"character": 8
}
],
"signatures": [
{
"id": 250,
"name": "getUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Get user by id."
},
"parameters": [
{
"id": 251,
"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": 252,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 254,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 717,
"character": 27
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 253,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 717,
"character": 15
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
254,
253
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 255,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 257,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 717,
"character": 57
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 256,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 717,
"character": 45
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
257,
256
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 176,
"name": "inviteUserByEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 505,
"character": 8
}
],
"signatures": [
{
"id": 177,
"name": "inviteUserByEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends an invite link to an email address."
},
"parameters": [
{
"id": 178,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 179,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 180,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 182,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional user metadata\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 509,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 181,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 508,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
182,
181
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 183,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 185,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 514,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 184,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 513,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
185,
184
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 186,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 188,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 516,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 187,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 516,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
188,
187
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 241,
"name": "listUsers",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 693,
"character": 8
}
],
"signatures": [
{
"id": 242,
"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": 243,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 245,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 693,
"character": 46
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 244,
"name": "users",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 693,
"character": 31
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 548,
"name": "User"
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
245,
244
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 246,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 248,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 693,
"character": 77
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 247,
"name": "users",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 693,
"character": 64
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
248,
247
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 203,
"name": "refreshAccessToken",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 584,
"character": 8
}
],
"signatures": [
{
"id": 204,
"name": "refreshAccessToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Generates a new JWT."
},
"parameters": [
{
"id": 205,
"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": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 206,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 208,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 587,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 207,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 586,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
208,
207
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 209,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 211,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 589,
"character": 23
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 210,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 589,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
211,
210
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 189,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 545,
"character": 8
}
],
"signatures": [
{
"id": 190,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a reset request to an email address."
},
"parameters": [
{
"id": 191,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 192,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 193,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 195,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 549,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 194,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 548,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
195,
194
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 196,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 197,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 553,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 198,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
},
{
"id": 199,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 554,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
197,
199
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 200,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 201,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 556,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 202,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 556,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
201,
202
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 111,
"name": "sendMagicLinkEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 307,
"character": 8
}
],
"signatures": [
{
"id": 112,
"name": "sendMagicLinkEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Sends a magic login link to an email address."
},
"parameters": [
{
"id": 113,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 114,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 115,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 118,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 312,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 117,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 311,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 116,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 310,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
118,
117,
116
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 119,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 120,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 316,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 121,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
},
{
"id": 122,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 317,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
120,
122
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 123,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 124,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 319,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 125,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 319,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
124,
125
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 126,
"name": "sendMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 354,
"character": 8
}
],
"signatures": [
{
"id": 127,
"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": 128,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 129,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 130,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 132,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 358,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 131,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 357,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
132,
131
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 133,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 134,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 362,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 135,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
}
},
{
"id": 136,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 363,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
134,
136
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 137,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 138,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 365,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 139,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 365,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
138,
139
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 59,
"name": "signInWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 140,
"character": 8
}
],
"signatures": [
{
"id": 60,
"name": "signInWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their email address."
},
"parameters": [
{
"id": 61,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 62,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 63,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 64,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 65,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 144,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
65
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 66,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 67,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 148,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 68,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 149,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
67,
68
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 69,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 70,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 151,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 71,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 151,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
70,
71
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 102,
"name": "signInWithOpenIDConnect",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 267,
"character": 8
}
],
"signatures": [
{
"id": 103,
"name": "signInWithOpenIDConnect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an OpenID Connect user using their id_token."
},
"parameters": [
{
"id": 104,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 653,
"name": "OpenIDConnectCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 105,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 107,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 276,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 106,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 275,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
107,
106
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 110,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 278,
"character": 23
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 109,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 278,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
110,
109
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 89,
"name": "signInWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 227,
"character": 8
}
],
"signatures": [
{
"id": 90,
"name": "signInWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Logs in an existing user using their phone number and password."
},
"parameters": [
{
"id": 91,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 92,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 93,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 94,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 95,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Verification token received when the user completes the captcha on your site.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 231,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
95
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 96,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 98,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 236,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 97,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 235,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
98,
97
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 99,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 101,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 238,
"character": 23
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 100,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 238,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
101,
100
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 140,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 394,
"character": 8
}
],
"signatures": [
{
"id": 141,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 142,
"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": 143,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 144,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 394,
"character": 40
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 670,
"name": "AuthError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
144
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 41,
"name": "signUpWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 86,
"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": 92,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional user metadata.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 91,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 47,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed."
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 90,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
49,
48,
47
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 50,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 51,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 96,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 52,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 97,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
51,
52
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 53,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 54,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 100,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 55,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 101,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
54,
55
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 56,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 57,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 103,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 58,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 103,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
57,
58
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 72,
"name": "signUpWithPhone",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 178,
"character": 8
}
],
"signatures": [
{
"id": 73,
"name": "signUpWithPhone",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Signs up a new user using their phone number and a password."
},
"parameters": [
{
"id": 74,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The phone number of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 75,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 76,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 77,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 79,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 183,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 78,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional user metadata.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 182,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
79,
78
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 80,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 81,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 187,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 82,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 188,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
81,
82
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 83,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 84,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 191,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 85,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 192,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
84,
85
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 86,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 87,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 194,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 88,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 194,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
87,
88
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 286,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 832,
"character": 8
}
],
"signatures": [
{
"id": 287,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 288,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 289,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The data you want to update.\n"
},
"type": {
"type": "reference",
"id": 576,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 290,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 292,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 838,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 291,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 837,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
292,
291
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 293,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 295,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 840,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 294,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 840,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
295,
294
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 258,
"name": "updateUserById",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 739,
"character": 8
}
],
"signatures": [
{
"id": 259,
"name": "updateUserById",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 260,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 261,
"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": 582,
"name": "AdminUserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 264,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 745,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 263,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 744,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
264,
263
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 265,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 267,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 747,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 266,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 747,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
267,
266
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 145,
"name": "verifyMobileOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 418,
"character": 8
}
],
"signatures": [
{
"id": 146,
"name": "verifyMobileOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `verifyOTP` instead!"
}
]
},
"parameters": [
{
"id": 147,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The user's phone number WITH international prefix"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 148,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "token that user was sent to their mobile phone"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 149,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 150,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 151,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 422,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
151
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 152,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 153,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 426,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 154,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 427,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
153,
154
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 155,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 156,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 430,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 157,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 431,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
156,
157
]
}
]
}
},
{
"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": 433,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 160,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 433,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
159,
160
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 161,
"name": "verifyOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 463,
"character": 8
}
],
"signatures": [
{
"id": 162,
"name": "verifyOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Send User supplied Email / Mobile OTP to be verified"
},
"parameters": [
{
"id": 163,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 640,
"name": "VerifyOTPParams"
}
},
{
"id": 164,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 165,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 166,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed.\n"
},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 466,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
166
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 167,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 168,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 470,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
},
{
"id": 169,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 471,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
168,
169
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 170,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 171,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 474,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 172,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 475,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
171,
172
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 173,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 174,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 477,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 175,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 477,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
174,
175
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
21,
17,
16
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
26,
230,
268,
212,
30,
277,
249,
176,
241,
203,
189,
111,
126,
59,
102,
89,
140,
41,
72,
286,
258,
145,
161
]
}
],
"sources": [
{
"fileName": "src/GoTrueApi.ts",
"line": 14,
"character": 21
}
]
},
{
"id": 296,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 297,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 98,
"character": 2
}
],
"signatures": [
{
"id": 298,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 299,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 300,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 308,
"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": 103,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 307,
"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": 102,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 312,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 107,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 313,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 314,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "A custom fetch implementation.\n"
},
"parameters": [
{
"id": 315,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 316,
"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": 302,
"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": 100,
"character": 4
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 303,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 304,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 305,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 311,
"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": 106,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 309,
"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. If set to false, session will just be saved in memory."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 104,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 310,
"name": "storage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 105,
"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": "removeItem"
},
{
"type": "literal",
"value": "setItem"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 306,
"name": "storageKey",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 101,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 301,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The URL of the GoTrue server."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 99,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
308,
307,
312,
302,
311,
309,
310,
306,
301
]
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 296,
"name": "default"
}
}
]
},
{
"id": 317,
"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": 65,
"character": 2
}
],
"type": {
"type": "reference",
"id": 1,
"name": "default"
}
},
{
"id": 320,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 77,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 319,
"name": "inMemorySession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null.\nOnly used if persistSession is false."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 75,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 529,
"name": "Session"
}
]
}
},
{
"id": 325,
"name": "networkRetries",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 83,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 321,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 78,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 324,
"name": "refreshTokenTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 81,
"character": 12
}
],
"type": {
"type": "reference",
"qualifiedName": "global.NodeJS.Timeout",
"package": "@types/node",
"name": "Timeout"
}
},
{
"id": 326,
"name": "refreshingDeferred",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 84,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 660,
"name": "CallRefreshTokenResult"
}
],
"name": "Deferred"
}
]
},
"defaultValue": "null"
},
{
"id": 323,
"name": "stateChangeEmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 80,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"id": 592,
"name": "Subscription"
}
],
"qualifiedName": "Map",
"package": "typescript",
"name": "Map"
},
"defaultValue": "..."
},
{
"id": 322,
"name": "storage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 79,
"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": "removeItem"
},
{
"type": "literal",
"value": "setItem"
}
]
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
],
"name": "PromisifyMethods"
}
},
{
"id": 318,
"name": "storageKey",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"comment": {
"shortText": "The storage key used to identity the values saved in localStorage"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 69,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 480,
"name": "_callRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 775,
"character": 16
}
],
"signatures": [
{
"id": 481,
"name": "_callRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 482,
"name": "refreshToken",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 660,
"name": "CallRefreshTokenResult"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 421,
"name": "_doesSessionExist",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 599,
"character": 10
}
],
"signatures": [
{
"id": 422,
"name": "_doesSessionExist",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 423,
"name": "maybeSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "maybeSession",
"asserts": false,
"targetType": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
}
]
},
{
"id": 424,
"name": "_handleEmailSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 610,
"character": 16
}
],
"signatures": [
{
"id": 425,
"name": "_handleEmailSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 426,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 427,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 428,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 429,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 430,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 614,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
430
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 503,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 467,
"name": "_handleOpenIDConnectSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 686,
"character": 16
}
],
"signatures": [
{
"id": 468,
"name": "_handleOpenIDConnectSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 469,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 653,
"name": "OpenIDConnectCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 470,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 473,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 696,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 472,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 695,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 529,
"name": "Session"
}
]
}
},
{
"id": 471,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 694,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 548,
"name": "User"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
473,
472,
471
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 474,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 477,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 698,
"character": 35
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 476,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 698,
"character": 20
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 475,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 698,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
477,
476,
475
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 431,
"name": "_handlePhoneSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 638,
"character": 16
}
],
"signatures": [
{
"id": 432,
"name": "_handlePhoneSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 433,
"name": "phone",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 434,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 435,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 436,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 437,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 642,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
437
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 438,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 439,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 649,
"character": 38
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 440,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 441,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 649,
"character": 46
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 442,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 649,
"character": 61
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
441,
442
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 443,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
439,
443
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 444,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 445,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 656,
"character": 15
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 446,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 447,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
},
{
"id": 448,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 656,
"character": 32
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
},
"defaultValue": "session.user"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
447,
448
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 449,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 656,
"character": 54
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
445,
449
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 450,
"name": "_handleProviderSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 666,
"character": 10
}
],
"signatures": [
{
"id": 451,
"name": "_handleProviderSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 452,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 453,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 454,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 457,
"name": "queryParams",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 671,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 458,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 459,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 460,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 455,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 669,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 456,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 670,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
457,
455,
456
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 461,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 462,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 683,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 463,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 464,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 465,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
464,
465
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 466,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 683,
"character": 38
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
462,
466
]
}
]
}
}
}
]
},
{
"id": 499,
"name": "_handleVisibilityChange",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 883,
"character": 10
}
],
"signatures": [
{
"id": 500,
"name": "_handleVisibilityChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "literal",
"value": false
}
]
}
}
]
},
{
"id": 483,
"name": "_notifyAllSubscribers",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 815,
"character": 10
}
],
"signatures": [
{
"id": 484,
"name": "_notifyAllSubscribers",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 485,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 502,
"name": "AuthChangeEvent"
}
},
{
"id": 486,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 529,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 490,
"name": "_persistSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 843,
"character": 10
}
],
"signatures": [
{
"id": 491,
"name": "_persistSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 492,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 478,
"name": "_recoverAndRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 730,
"character": 16
}
],
"signatures": [
{
"id": 479,
"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": 493,
"name": "_removeSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 847,
"character": 16
}
],
"signatures": [
{
"id": 494,
"name": "_removeSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 487,
"name": "_saveSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 823,
"character": 10
}
],
"signatures": [
{
"id": 488,
"name": "_saveSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible"
},
"parameters": [
{
"id": 489,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 495,
"name": "_startAutoRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 863,
"character": 10
}
],
"signatures": [
{
"id": 496,
"name": "_startAutoRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Clear and re-create refresh token timer"
},
"parameters": [
{
"id": 497,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "time intervals in milliseconds\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 498,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 350,
"name": "getSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 341,
"character": 8
}
],
"signatures": [
{
"id": 351,
"name": "getSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the session data, refreshing it if necessary."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 352,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 354,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 344,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 353,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 343,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
354,
353
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 355,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 357,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 348,
"character": 8
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 356,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 347,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
357,
356
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 358,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 360,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 352,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 359,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 351,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
360,
359
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 393,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 489,
"character": 8
}
],
"signatures": [
{
"id": 394,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 395,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 396,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 397,
"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": 489,
"character": 38
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
397
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 398,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 400,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 492,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 399,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 491,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
400,
399
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 401,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 403,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 494,
"character": 23
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 402,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 494,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
403,
402
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 361,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 391,
"character": 8
}
],
"signatures": [
{
"id": 362,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns the user data, refreshing the session if necessary."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 363,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 365,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 394,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 364,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 393,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
365,
364
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 366,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 368,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 398,
"character": 8
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 367,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 397,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
368,
367
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 369,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 371,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 402,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 370,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 401,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
371,
370
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 408,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 573,
"character": 2
}
],
"signatures": [
{
"id": 409,
"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": 410,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 411,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 412,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 413,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 502,
"name": "AuthChangeEvent"
}
},
{
"id": 414,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 529,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 415,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 417,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 576,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 416,
"name": "subscription",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 575,
"character": 8
}
],
"type": {
"type": "reference",
"id": 592,
"name": "Subscription"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
417,
416
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 418,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 420,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 578,
"character": 28
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 419,
"name": "subscription",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 578,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
420,
419
]
}
]
}
}
]
}
}
]
},
{
"id": 381,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 455,
"character": 8
}
],
"signatures": [
{
"id": 382,
"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": 383,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "a JWT token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 384,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 386,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 458,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 385,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 457,
"character": 8
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
386,
385
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 387,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 389,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 460,
"character": 23
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 388,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 460,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
389,
388
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 390,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 392,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 461,
"character": 23
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 391,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 461,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
392,
391
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 338,
"name": "signInWithOAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 240,
"character": 8
}
],
"signatures": [
{
"id": 339,
"name": "signInWithOAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user via a third-party provider."
},
"parameters": [
{
"id": 340,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 629,
"name": "SignInWithOAuthCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 516,
"name": "OAuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 341,
"name": "signInWithOtp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 256,
"character": 8
}
],
"signatures": [
{
"id": 342,
"name": "signInWithOtp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Passwordless method for logging in an existing user."
},
"parameters": [
{
"id": 343,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 618,
"name": "SignInWithPasswordlessCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 503,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 335,
"name": "signInWithPassword",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 203,
"character": 8
}
],
"signatures": [
{
"id": 336,
"name": "signInWithPassword",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 337,
"name": "credentials",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 607,
"name": "SignInWithPasswordCredentials"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 503,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 404,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 554,
"character": 8
}
],
"signatures": [
{
"id": 405,
"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 revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`. There is no way to revoke a user's session JWT before it automatically expires\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 406,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 407,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 554,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 670,
"name": "AuthError"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
407
]
}
]
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 327,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 142,
"character": 8
}
],
"signatures": [
{
"id": 328,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 329,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 600,
"name": "UserCredentials"
}
},
{
"id": 330,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 331,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 334,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 147,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 333,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Optional user metadata.\n"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 146,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 332,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup."
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 145,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
334,
333,
332
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 503,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 372,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 420,
"character": 8
}
],
"signatures": [
{
"id": 373,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 374,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 576,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 375,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 377,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 423,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 376,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 422,
"character": 8
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
377,
376
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 378,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 380,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 425,
"character": 20
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 379,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 425,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
380,
379
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 344,
"name": "verifyOTP",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 295,
"character": 8
}
],
"signatures": [
{
"id": 345,
"name": "verifyOTP",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Log in a user given a User supplied OTP received via mobile."
},
"parameters": [
{
"id": 346,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 640,
"name": "VerifyOTPParams"
}
},
{
"id": 347,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 348,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 349,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "A URL or mobile address to send the user to after they are confirmed.\n"
},
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 298,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
349
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 503,
"name": "AuthResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
297
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
317,
320,
319,
325,
321,
324,
326,
323,
322,
318
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
480,
421,
424,
467,
431,
450,
499,
483,
490,
478,
493,
487,
495,
350,
393,
361,
408,
381,
338,
341,
335,
404,
327,
372,
344
]
}
],
"sources": [
{
"fileName": "src/GoTrueClient.ts",
"line": 60,
"character": 21
}
]
},
{
"id": 582,
"name": "AdminUserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 584,
"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": 165,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 591,
"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": 140,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
},
"inheritedFrom": {
"type": "reference",
"id": 581,
"name": "UserAttributes.data"
}
},
{
"id": 587,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 120,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 577,
"name": "UserAttributes.email"
}
},
{
"id": 590,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 135,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 580,
"name": "UserAttributes.email_change_token"
}
},
{
"id": 585,
"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": 172,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 589,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 130,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 579,
"name": "UserAttributes.password"
}
},
{
"id": 588,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 125,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 578,
"name": "UserAttributes.phone"
}
},
{
"id": 586,
"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": 179,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 583,
"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": 155,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
584,
591,
587,
590,
585,
589,
588,
586,
583
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 143,
"character": 17
}
],
"extendedTypes": [
{
"type": "reference",
"id": 576,
"name": "UserAttributes"
}
]
},
{
"id": 653,
"name": "OpenIDConnectCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 657,
"name": "client_id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 265,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 654,
"name": "id_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 262,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 658,
"name": "issuer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 266,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 655,
"name": "nonce",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 263,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 656,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 264,
"character": 2
}
],
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
657,
654,
658,
655,
656
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 261,
"character": 17
}
]
},
{
"id": 529,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 531,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 533,
"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": 70,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 532,
"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": 66,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 530,
"name": "provider_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 61,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 534,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 71,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 535,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 72,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 536,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 73,
"character": 2
}
],
"type": {
"type": "reference",
"id": 548,
"name": "User"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
531,
533,
532,
530,
534,
535,
536
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 60,
"character": 17
}
]
},
{
"id": 633,
"name": "SignInWithOAuthOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 636,
"name": "queryParams",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 242,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 637,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 638,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 639,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 634,
"name": "redirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 240,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 635,
"name": "scopes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 241,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
636,
634,
635
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 239,
"character": 17
}
]
},
{
"id": 616,
"name": "SignInWithPasswordOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 617,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 218,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
617
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 217,
"character": 17
}
]
},
{
"id": 625,
"name": "SignInWithPasswordlessOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 628,
"name": "captchaToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 233,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 626,
"name": "emailRedirectTo",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The redirect url embedded in the email link"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 231,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 627,
"name": "shouldCreateUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 232,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
628,
626,
627
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 229,
"character": 17
}
]
},
{
"id": 592,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 593,
"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": 186,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 594,
"name": "callback",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 190,
"character": 2
}
],
"signatures": [
{
"id": 595,
"name": "callback",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"parameters": [
{
"id": 596,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 502,
"name": "AuthChangeEvent"
}
},
{
"id": 597,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"id": 529,
"name": "Session"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 598,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 194,
"character": 2
}
],
"signatures": [
{
"id": 599,
"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": [
593
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
594,
598
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 182,
"character": 17
}
]
},
{
"id": 548,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 565,
"name": "action_link",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 103,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 550,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 551,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 552,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 91,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
552
]
}
],
"indexSignature": {
"id": 553,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 554,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 559,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 97,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 560,
"name": "confirmation_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 98,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 569,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 107,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 568,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 106,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 566,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 104,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 562,
"name": "email_change_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 100,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 570,
"name": "email_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 108,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 549,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 89,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 575,
"name": "identities",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 113,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 537,
"name": "UserIdentity"
}
}
},
{
"id": 564,
"name": "invited_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 102,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 572,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 563,
"name": "new_email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 101,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 567,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 105,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 571,
"name": "phone_confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 109,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 561,
"name": "recovery_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 99,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 573,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 111,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 574,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 112,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 555,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 94,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 556,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 557,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 558,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
565,
550,
559,
560,
569,
568,
566,
562,
570,
549,
575,
564,
572,
563,
567,
571,
561,
573,
574,
555
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 88,
"character": 17
}
]
},
{
"id": 576,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 581,
"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": 140,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 577,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 120,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 580,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 135,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 579,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 130,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 578,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The user's phone."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 125,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
581,
577,
580,
579,
578
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 116,
"character": 17
}
],
"extendedBy": [
{
"type": "reference",
"id": 582,
"name": "AdminUserAttributes"
}
]
},
{
"id": 600,
"name": "UserCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 601,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 198,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 606,
"name": "oidc",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 204,
"character": 2
}
],
"type": {
"type": "reference",
"id": 653,
"name": "OpenIDConnectCredentials"
}
},
{
"id": 603,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 200,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 602,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 199,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 605,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The name of the provider."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 203,
"character": 2
}
],
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 604,
"name": "refreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 201,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
601,
606,
603,
602,
605,
604
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 197,
"character": 17
}
]
},
{
"id": 537,
"name": "UserIdentity",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 545,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 83,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 538,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 77,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 540,
"name": "identity_data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 79,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 541,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 542,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 543,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
}
}
},
{
"id": 546,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 84,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 544,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 547,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 85,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 539,
"name": "user_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 78,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
545,
538,
540,
546,
544,
547,
539
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 76,
"character": 17
}
]
},
{
"id": 646,
"name": "VerifyEmailOTPParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 647,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 253,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 648,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 254,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 649,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 255,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 650,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 256,
"character": 2
}
],
"type": {
"type": "reference",
"id": 652,
"name": "EmailOTPType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
647,
648,
649,
650
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 252,
"character": 17
}
]
},
{
"id": 641,
"name": "VerifyMobileOTPParams",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 642,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 247,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "undefined"
}
},
{
"id": 643,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 248,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 644,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 249,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 645,
"name": "type",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 250,
"character": 2
}
],
"type": {
"type": "reference",
"id": 651,
"name": "MobileOTPType"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
642,
643,
644,
645
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 246,
"character": 17
}
]
},
{
"id": 502,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 21,
"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": 503,
"name": "AuthResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 504,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 505,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 31,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 506,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 508,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 529,
"name": "Session"
},
{
"type": "literal",
"value": null
}
]
}
},
{
"id": 507,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 32,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 548,
"name": "User"
},
{
"type": "literal",
"value": null
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
508,
507
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 31,
"character": 12
}
]
}
}
},
{
"id": 509,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 35,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
505,
509
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 30,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 510,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 511,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 38,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 512,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 514,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 40,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 513,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 39,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
514,
513
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 38,
"character": 12
}
]
}
}
},
{
"id": 515,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 42,
"character": 6
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
511,
515
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 37,
"character": 4
}
]
}
}
]
}
},
{
"id": 660,
"name": "CallRefreshTokenResult",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 280,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 661,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 663,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 283,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 662,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 282,
"character": 6
}
],
"type": {
"type": "reference",
"id": 529,
"name": "Session"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
663,
662
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 281,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 664,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 666,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 287,
"character": 6
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
},
{
"id": 665,
"name": "session",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 286,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
666,
665
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 285,
"character": 4
}
]
}
}
]
}
},
{
"id": 652,
"name": "EmailOTPType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 259,
"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": 651,
"name": "MobileOTPType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 258,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "sms"
},
{
"type": "literal",
"value": "phone_change"
}
]
}
},
{
"id": 516,
"name": "OAuthResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 45,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 517,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 518,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 47,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 519,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 520,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 48,
"character": 8
}
],
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 521,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 49,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
520,
521
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 47,
"character": 12
}
]
}
}
},
{
"id": 522,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 51,
"character": 6
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
518,
522
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 46,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 523,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 524,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 525,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 526,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 55,
"character": 8
}
],
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
},
{
"id": 527,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 56,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
526,
527
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 54,
"character": 12
}
]
}
}
},
{
"id": 528,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 58,
"character": 6
}
],
"type": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
524,
528
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 53,
"character": 4
}
]
}
}
]
}
},
{
"id": 501,
"name": "Provider",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 3,
"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": 629,
"name": "SignInWithOAuthCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 235,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 630,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 632,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 237,
"character": 2
}
],
"type": {
"type": "reference",
"id": 633,
"name": "SignInWithOAuthOptions"
}
},
{
"id": 631,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 236,
"character": 2
}
],
"type": {
"type": "reference",
"id": 501,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
632,
631
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 235,
"character": 41
}
]
}
}
},
{
"id": 607,
"name": "SignInWithPasswordCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 206,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 608,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 609,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 208,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 611,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 210,
"character": 6
}
],
"type": {
"type": "reference",
"id": 616,
"name": "SignInWithPasswordOptions"
}
},
{
"id": 610,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 209,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
609,
611,
610
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 207,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 612,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 615,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 215,
"character": 6
}
],
"type": {
"type": "reference",
"id": 616,
"name": "SignInWithPasswordOptions"
}
},
{
"id": 614,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 214,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 613,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 213,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
615,
614,
613
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 212,
"character": 4
}
]
}
}
]
}
},
{
"id": 618,
"name": "SignInWithPasswordlessCredentials",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 220,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 619,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 620,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 222,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 621,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 223,
"character": 6
}
],
"type": {
"type": "reference",
"id": 625,
"name": "SignInWithPasswordlessOptions"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
620,
621
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 221,
"character": 4
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 622,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 624,
"name": "options",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 227,
"character": 6
}
],
"type": {
"type": "reference",
"id": 625,
"name": "SignInWithPasswordlessOptions"
}
},
{
"id": 623,
"name": "phone",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 226,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
624,
623
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 225,
"character": 4
}
]
}
}
]
}
},
{
"id": 659,
"name": "SupportedStorage",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 278,
"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": 640,
"name": "VerifyOTPParams",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 245,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 641,
"name": "VerifyMobileOTPParams"
},
{
"type": "reference",
"id": 646,
"name": "VerifyEmailOTPParams"
}
]
}
},
{
"id": 667,
"name": "isAuthError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 10,
"character": 16
}
],
"signatures": [
{
"id": 668,
"name": "isAuthError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 669,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 670,
"name": "AuthError"
}
}
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
675,
670,
722,
735,
710,
688,
695,
1,
296
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
582,
653,
529,
633,
616,
625,
592,
548,
576,
600,
537,
646,
641
]
},
{
"title": "Type Aliases",
"kind": 4194304,
"children": [
502,
503,
660,
652,
651,
516,
501,
629,
607,
618,
659,
640
]
},
{
"title": "Functions",
"kind": 64,
"children": [
667
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
}