diff --git a/spec/api_v0_openapi.json b/spec/api_v0_openapi.json index 7867f4a7d1b..b634edfa990 100644 --- a/spec/api_v0_openapi.json +++ b/spec/api_v0_openapi.json @@ -1116,18 +1116,18 @@ "PostgrestConfigResponse": { "type": "object", "properties": { + "max_rows": { "type": "integer" }, "db_schema": { "type": "string" }, - "max_rows": { "type": "number" }, "db_extra_search_path": { "type": "string" } }, - "required": ["db_schema", "max_rows", "db_extra_search_path"] + "required": ["max_rows", "db_schema", "db_extra_search_path"] }, "UpdatePostgrestConfigBody": { "type": "object", "properties": { + "max_rows": { "type": "integer", "minimum": 0, "maximum": 1000000 }, "db_extra_search_path": { "type": "string" }, - "db_schema": { "type": "string" }, - "max_rows": { "type": "number", "maximum": 1000000 } + "db_schema": { "type": "string" } } }, "UpdateCustomHostnameResponse": { diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index a554ca552fb..4af3936ad21 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -405,13 +405,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -477,9 +471,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -580,10 +572,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -626,12 +615,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -2083,10 +2067,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 157, - 156 - ] + "children": [157, 156] } ] } @@ -2204,53 +2185,22 @@ { "title": "Constructors", "kind": 512, - "children": [ - 105 - ] + "children": [105] }, { "title": "Properties", "kind": 1024, - "children": [ - 113, - 115, - 126, - 121, - 117, - 127, - 118, - 114, - 119, - 120, - 116, - 132, - 131 - ] + "children": [113, 115, 126, 121, 117, 127, 118, 114, 119, 120, 116, 132, 131] }, { "title": "Accessors", "kind": 262144, - "children": [ - 133, - 135 - ] + "children": [133, 135] }, { "title": "Methods", "kind": 2048, - "children": [ - 169, - 186, - 180, - 171, - 183, - 158, - 137, - 162, - 167, - 164, - 148 - ] + "children": [169, 186, 180, 171, 183, 158, 137, 162, 167, 164, 148] } ], "sources": [ @@ -2745,13 +2695,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -2817,9 +2761,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -2920,10 +2862,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -2966,12 +2905,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -3017,23 +2951,17 @@ { "title": "References", "kind": 16777216, - "children": [ - 194 - ] + "children": [194] }, { "title": "Classes", "kind": 128, - "children": [ - 104 - ] + "children": [104] }, { "title": "Functions", "kind": 64, - "children": [ - 2 - ] + "children": [2] } ], "sources": [ @@ -3099,9 +3027,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 13 - ] + "children": [13] } ] } @@ -3113,9 +3039,7 @@ { "title": "Variables", "kind": 32, - "children": [ - 11 - ] + "children": [11] } ], "sources": [ @@ -3549,11 +3473,7 @@ { "title": "Functions", "kind": 64, - "children": [ - 29, - 15, - 26 - ] + "children": [29, 15, 26] } ], "sources": [ @@ -3854,13 +3774,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -3926,9 +3840,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -4029,10 +3941,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -4075,12 +3984,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -4294,13 +4198,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -4366,9 +4264,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -4469,10 +4365,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -4515,12 +4408,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -4650,12 +4538,7 @@ { "title": "Functions", "kind": 64, - "children": [ - 50, - 56, - 47, - 45 - ] + "children": [50, 56, 47, 45] } ], "sources": [ @@ -4792,10 +4675,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 95, - 96 - ] + "children": [95, 96] } ], "sources": [ @@ -4865,9 +4745,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 91 - ] + "children": [91] } ], "sources": [ @@ -5000,11 +4878,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 101, - 99, - 100 - ] + "children": [101, 99, 100] } ], "sources": [ @@ -5134,11 +5008,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 82, - 81, - 83 - ] + "children": [82, 81, 83] } ], "sources": [ @@ -5268,11 +5138,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 87, - 86, - 88 - ] + "children": [87, 86, 88] } ], "sources": [ @@ -5418,11 +5284,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 87, - 86, - 88 - ] + "children": [87, 86, 88] } ], "sources": [ @@ -5492,9 +5354,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 91 - ] + "children": [91] } ], "sources": [ @@ -5693,13 +5553,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -5765,9 +5619,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -5868,10 +5720,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -5914,12 +5763,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -5937,23 +5781,12 @@ { "title": "Interfaces", "kind": 256, - "children": [ - 59 - ] + "children": [59] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 60, - 93, - 89, - 97, - 79, - 84, - 92, - 61 - ] + "children": [60, 93, 89, 97, 79, 84, 92, 61] } ], "sources": [ @@ -5997,9 +5830,7 @@ { "title": "Variables", "kind": 32, - "children": [ - 103 - ] + "children": [103] } ], "sources": [ @@ -6015,14 +5846,7 @@ { "title": "Modules", "kind": 2, - "children": [ - 1, - 10, - 14, - 44, - 58, - 102 - ] + "children": [1, 10, 14, 44, 58, 102] } ] }, @@ -6212,11 +6036,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 742, - 741, - 743 - ] + "children": [742, 741, 743] } ] } @@ -6229,23 +6049,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 733 - ] + "children": [733] }, { "title": "Properties", "kind": 1024, - "children": [ - 737 - ] + "children": [737] }, { "title": "Methods", "kind": 2048, - "children": [ - 738 - ] + "children": [738] } ], "sources": [ @@ -6324,9 +6138,7 @@ { "title": "Constructors", "kind": 512, - "children": [ - 728 - ] + "children": [728] } ], "sources": [ @@ -6464,10 +6276,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 799, - 798 - ] + "children": [799, 798] } ] } @@ -6565,10 +6374,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 803, - 802 - ] + "children": [803, 802] } ] } @@ -6722,10 +6528,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 813, - 812 - ] + "children": [813, 812] } ] } @@ -6796,12 +6599,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 810, - 808, - 807, - 809 - ] + "children": [810, 808, 807, 809] } ] } @@ -6824,25 +6622,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 793 - ] + "children": [793] }, { "title": "Properties", "kind": 1024, - "children": [ - 800, - 814, - 815 - ] + "children": [800, 814, 815] }, { "title": "Methods", "kind": 2048, - "children": [ - 804 - ] + "children": [804] } ], "sources": [ @@ -7055,11 +6845,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 789, - 788, - 790 - ] + "children": [789, 788, 790] } ] } @@ -7082,24 +6868,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 780 - ] + "children": [780] }, { "title": "Properties", "kind": 1024, - "children": [ - 783, - 784 - ] + "children": [783, 784] }, { "title": "Methods", "kind": 2048, - "children": [ - 785 - ] + "children": [785] } ], "sources": [ @@ -7323,11 +7102,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 828, - 827, - 829 - ] + "children": [828, 827, 829] } ] } @@ -7350,24 +7125,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 818 - ] + "children": [818] }, { "title": "Properties", "kind": 1024, - "children": [ - 822, - 823 - ] + "children": [822, 823] }, { "title": "Methods", "kind": 2048, - "children": [ - 824 - ] + "children": [824] } ], "sources": [ @@ -7567,11 +7335,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 776, - 775, - 777 - ] + "children": [776, 775, 777] } ] } @@ -7594,24 +7358,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 768 - ] + "children": [768] }, { "title": "Properties", "kind": 1024, - "children": [ - 770, - 771 - ] + "children": [770, 771] }, { "title": "Methods", "kind": 2048, - "children": [ - 772 - ] + "children": [772] } ], "sources": [ @@ -7721,16 +7478,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 746 - ] + "children": [746] }, { "title": "Properties", "kind": 1024, - "children": [ - 750 - ] + "children": [750] } ], "sources": [ @@ -7959,11 +7712,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 764, - 763, - 765 - ] + "children": [764, 763, 765] } ] } @@ -7976,24 +7725,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 753 - ] + "children": [753] }, { "title": "Properties", "kind": 1024, - "children": [ - 758, - 759 - ] + "children": [758, 759] }, { "title": "Methods", "kind": 2048, - "children": [ - 760 - ] + "children": [760] } ], "sources": [ @@ -8238,11 +7980,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 11, - 7, - 6 - ] + "children": [11, 7, 6] } ] } @@ -8558,17 +8296,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -8833,12 +8561,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -8968,11 +8691,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -9084,11 +8803,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -9230,12 +8945,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -9429,10 +9139,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 39, - 38 - ] + "children": [39, 38] } ] } @@ -9569,10 +9276,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 719, - 720 - ] + "children": [719, 720] } ], "sources": [ @@ -9652,9 +9356,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 52 - ] + "children": [52] } ] } @@ -9683,10 +9385,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 50, - 53 - ] + "children": [50, 53] } ] } @@ -9744,9 +9443,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 57 - ] + "children": [57] } ] } @@ -9776,10 +9473,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 55, - 58 - ] + "children": [55, 58] } ] } @@ -9896,10 +9590,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 31, - 32 - ] + "children": [31, 32] } ] } @@ -10205,17 +9896,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -10257,30 +9938,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 16 - ] + "children": [16] }, { "title": "Methods", "kind": 2048, - "children": [ - 43, - 66, - 40, - 59, - 33, - 46, - 27, - 62 - ] + "children": [43, 66, 40, 59, 33, 46, 27, 62] } ], "sources": [ @@ -10556,16 +10224,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 297, - 296, - 300, - 291, - 298, - 299, - 295, - 290 - ] + "children": [297, 296, 300, 291, 298, 299, 295, 290] } ], "sources": [ @@ -10717,9 +10376,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 129 - ] + "children": [129] } ] } @@ -10748,10 +10405,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 127, - 130 - ] + "children": [127, 130] } ] } @@ -10810,9 +10464,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 134 - ] + "children": [134] } ] } @@ -10842,10 +10494,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 132, - 135 - ] + "children": [132, 135] } ] } @@ -10904,9 +10553,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 139 - ] + "children": [139] } ] } @@ -10935,10 +10582,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 137, - 140 - ] + "children": [137, 140] } ] } @@ -11197,9 +10841,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 195 - ] + "children": [195] } ] } @@ -11210,9 +10852,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 193 - ] + "children": [193] } ] } @@ -11287,9 +10927,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 164 - ] + "children": [164] } ] } @@ -11416,10 +11054,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 202, - 201 - ] + "children": [202, 201] } ] } @@ -11489,10 +11124,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 204, - 206 - ] + "children": [204, 206] } ] } @@ -11548,10 +11180,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208, - 209 - ] + "children": [208, 209] } ] } @@ -11649,10 +11278,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 158, - 159 - ] + "children": [158, 159] } ] } @@ -11865,11 +11491,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 485, - 483, - 484 - ] + "children": [485, 483, 484] } ], "sources": [ @@ -11909,10 +11531,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 481, - 480 - ] + "children": [481, 480] } ], "sources": [ @@ -12146,12 +11765,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 470, - 469, - 467, - 468 - ] + "children": [470, 469, 467, 468] } ], "sources": [ @@ -12169,10 +11783,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 464, - 465 - ] + "children": [464, 465] } ], "sources": [ @@ -12292,11 +11903,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 477, - 476, - 475 - ] + "children": [477, 476, 475] } ], "sources": [ @@ -12335,10 +11942,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 473, - 472 - ] + "children": [473, 472] } ], "sources": [ @@ -12528,10 +12132,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 454, - 453 - ] + "children": [454, 453] } ], "sources": [ @@ -12570,11 +12171,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 449, - 451, - 450 - ] + "children": [449, 451, 450] } ], "sources": [ @@ -12671,10 +12268,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 461, - 460 - ] + "children": [461, 460] } ], "sources": [ @@ -12734,11 +12328,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 458, - 457, - 456 - ] + "children": [458, 457, 456] } ], "sources": [ @@ -12913,10 +12503,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 513, - 512 - ] + "children": [513, 512] } ], "sources": [ @@ -12934,9 +12521,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 510 - ] + "children": [510] } ], "sources": [ @@ -12986,9 +12571,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 515 - ] + "children": [515] } ], "sources": [ @@ -13035,9 +12618,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 517 - ] + "children": [517] } ], "sources": [ @@ -13142,9 +12723,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 184 - ] + "children": [184] } ] } @@ -13337,11 +12916,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 439, - 438, - 437 - ] + "children": [439, 438, 437] } ], "sources": [ @@ -13380,11 +12955,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 433, - 435, - 434 - ] + "children": [433, 435, 434] } ], "sources": [ @@ -13481,10 +13052,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 446, - 445 - ] + "children": [446, 445] } ], "sources": [ @@ -13544,11 +13112,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 443, - 442, - 441 - ] + "children": [443, 442, 441] } ], "sources": [ @@ -13721,12 +13285,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 410, - 407, - 409, - 408 - ] + "children": [410, 407, 409, 408] } ], "sources": [ @@ -13901,10 +13460,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -13979,12 +13535,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -14098,10 +13649,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -14155,12 +13703,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -14198,37 +13741,18 @@ { "title": "Constructors", "kind": 512, - "children": [ - 76 - ] + "children": [76] }, { "title": "Properties", "kind": 1024, - "children": [ - 79, - 80 - ] + "children": [79, 80] }, { "title": "Methods", "kind": 2048, "children": [ - 124, - 141, - 102, - 185, - 160, - 196, - 154, - 112, - 115, - 109, - 121, - 181, - 106, - 144, - 118 + 124, 141, 102, 185, 160, 196, 154, 112, 115, 109, 121, 181, 106, 144, 118 ] } ], @@ -14304,10 +13828,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 357, - 358 - ] + "children": [357, 358] } ], "sources": [ @@ -14563,17 +14084,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -14751,14 +14262,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 375, - 373, - 372, - 371, - 374, - 376 - ] + "children": [375, 373, 372, 371, 374, 376] } ], "sources": [ @@ -14828,10 +14332,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 541, - 542 - ] + "children": [541, 542] } ], "sources": [ @@ -14972,10 +14473,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 685, - 686 - ] + "children": [685, 686] } ], "sources": [ @@ -15090,9 +14588,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 698 - ] + "children": [698] } ], "sources": [ @@ -15129,10 +14625,7 @@ { "title": "Methods", "kind": 2048, - "children": [ - 703, - 700 - ] + "children": [703, 700] } ], "sources": [ @@ -15228,9 +14721,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 580 - ] + "children": [580] } ], "sources": [ @@ -15358,10 +14849,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 584, - 583 - ] + "children": [584, 583] } ], "sources": [ @@ -15515,11 +15003,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 567, - 569, - 568 - ] + "children": [567, 569, 568] } ], "sources": [ @@ -15705,9 +15189,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 572 - ] + "children": [572] } ], "sources": [ @@ -15856,11 +15338,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 576, - 577, - 575 - ] + "children": [576, 577, 575] } ], "sources": [ @@ -15897,15 +15375,7 @@ { "title": "Methods", "kind": 2048, - "children": [ - 658, - 667, - 655, - 672, - 670, - 664, - 661 - ] + "children": [658, 667, 655, 672, 670, 664, 661] } ], "sources": [ @@ -16115,16 +15585,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 350, - 353, - 352, - 349, - 348, - 351, - 354, - 355 - ] + "children": [350, 353, 352, 349, 348, 351, 354, 355] } ], "sources": [ @@ -16324,17 +15785,12 @@ { "title": "Properties", "kind": 1024, - "children": [ - 422 - ] + "children": [422] }, { "title": "Methods", "kind": 2048, - "children": [ - 423, - 427 - ] + "children": [423, 427] } ], "sources": [ @@ -16375,9 +15831,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 430 - ] + "children": [430] } ], "sources": [ @@ -16821,27 +16275,8 @@ "title": "Properties", "kind": 1024, "children": [ - 394, - 386, - 388, - 389, - 398, - 397, - 395, - 391, - 399, - 405, - 385, - 404, - 393, - 401, - 392, - 396, - 400, - 390, - 402, - 403, - 387 + 394, 386, 388, 389, 398, 397, 395, 391, 399, 405, 385, 404, 393, 401, 392, 396, 400, + 390, 402, 403, 387 ] } ], @@ -16885,9 +16320,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 378 - ] + "children": [378] } ], "sources": [ @@ -17026,12 +16459,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 410, - 407, - 409, - 408 - ] + "children": [410, 407, 409, 408] } ], "sources": [ @@ -17218,15 +16646,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 367, - 360, - 362, - 368, - 366, - 369, - 361 - ] + "children": [367, 360, 362, 368, 366, 369, 361] } ], "sources": [ @@ -17377,10 +16797,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -17434,12 +16851,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -17538,10 +16950,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -17616,12 +17025,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -17788,10 +17192,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 685, - 686 - ] + "children": [685, 686] } ], "sources": [ @@ -17885,9 +17286,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 678 - ] + "children": [678] } ], "sources": [ @@ -17923,10 +17322,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 676, - 679 - ] + "children": [676, 679] } ], "sources": [ @@ -17989,10 +17385,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 681, - 682 - ] + "children": [681, 682] } ], "sources": [ @@ -18063,9 +17456,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 698 - ] + "children": [698] } ], "sources": [ @@ -18163,9 +17554,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 691 - ] + "children": [691] } ], "sources": [ @@ -18201,10 +17590,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 689, - 692 - ] + "children": [689, 692] } ], "sources": [ @@ -18267,10 +17653,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 694, - 695 - ] + "children": [694, 695] } ], "sources": [ @@ -18379,10 +17762,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 627, - 626 - ] + "children": [627, 626] } ], "sources": [ @@ -18418,10 +17798,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 624, - 628 - ] + "children": [624, 628] } ], "sources": [ @@ -18484,10 +17861,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 630, - 631 - ] + "children": [630, 631] } ], "sources": [ @@ -18663,11 +18037,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 606, - 607, - 608 - ] + "children": [606, 607, 608] } ], "sources": [ @@ -18706,11 +18076,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 602, - 604, - 603 - ] + "children": [602, 604, 603] } ], "sources": [ @@ -18746,10 +18112,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 600, - 609 - ] + "children": [600, 609] } ], "sources": [ @@ -18812,10 +18175,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 611, - 612 - ] + "children": [611, 612] } ], "sources": [ @@ -18975,11 +18335,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 649, - 647, - 648 - ] + "children": [649, 647, 648] } ], "sources": [ @@ -19015,10 +18371,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 645, - 650 - ] + "children": [645, 650] } ], "sources": [ @@ -19081,10 +18434,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 652, - 653 - ] + "children": [652, 653] } ], "sources": [ @@ -19201,10 +18551,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 636, - 637 - ] + "children": [636, 637] } ], "sources": [ @@ -19240,10 +18587,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 634, - 638 - ] + "children": [634, 638] } ], "sources": [ @@ -19306,10 +18650,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 640, - 641 - ] + "children": [640, 641] } ], "sources": [ @@ -19397,9 +18738,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 617 - ] + "children": [617] } ], "sources": [ @@ -19435,10 +18774,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 615, - 618 - ] + "children": [615, 618] } ], "sources": [ @@ -19501,10 +18837,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 620, - 621 - ] + "children": [620, 621] } ], "sources": [ @@ -19677,13 +19010,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 589, - 591, - 592, - 590, - 593 - ] + "children": [589, 591, 592, 590, 593] } ], "sources": [ @@ -19719,10 +19046,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 587, - 594 - ] + "children": [587, 594] } ], "sources": [ @@ -19785,10 +19109,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 596, - 597 - ] + "children": [596, 597] } ], "sources": [ @@ -19911,10 +19232,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 306, - 305 - ] + "children": [306, 305] } ], "sources": [ @@ -19950,10 +19268,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 303, - 307 - ] + "children": [303, 307] } ], "sources": [ @@ -20037,10 +19352,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 312, - 311 - ] + "children": [312, 311] } ], "sources": [ @@ -20077,10 +19389,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 309, - 313 - ] + "children": [309, 313] } ], "sources": [ @@ -20189,10 +19498,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 713, - 712 - ] + "children": [713, 712] } ], "sources": [ @@ -20255,10 +19561,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 716, - 715 - ] + "children": [716, 715] } ], "sources": [ @@ -20441,12 +19744,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -20576,11 +19874,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -20732,12 +20026,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -20867,11 +20156,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -20983,11 +20268,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -21129,12 +20410,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -21286,13 +20562,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 559, - 560, - 561, - 562, - 563 - ] + "children": [559, 560, 561, 562, 563] } ], "sources": [ @@ -21395,10 +20665,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 548, - 549 - ] + "children": [548, 549] } ], "sources": [ @@ -21434,10 +20701,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 546, - 550 - ] + "children": [546, 550] } ], "sources": [ @@ -21521,10 +20785,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 554, - 555 - ] + "children": [554, 555] } ], "sources": [ @@ -21561,10 +20822,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 552, - 556 - ] + "children": [552, 556] } ], "sources": [ @@ -21721,11 +20979,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -21861,12 +21115,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -22103,16 +21352,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 297, - 296, - 300, - 291, - 298, - 299, - 295, - 290 - ] + "children": [297, 296, 300, 291, 298, 299, 295, 290] } ], "sources": [ @@ -22180,9 +21420,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 709 - ] + "children": [709] } ], "sources": [ @@ -22264,10 +21502,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 584, - 583 - ] + "children": [584, 583] } ], "sources": [ @@ -22328,9 +21563,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 580 - ] + "children": [580] } ], "sources": [ @@ -22437,11 +21670,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 567, - 569, - 568 - ] + "children": [567, 569, 568] } ], "sources": [ @@ -22502,9 +21731,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 572 - ] + "children": [572] } ], "sources": [ @@ -22607,11 +21834,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 576, - 577, - 575 - ] + "children": [576, 577, 575] } ], "sources": [ @@ -22740,10 +21963,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 318, - 319 - ] + "children": [318, 319] } ], "sources": [ @@ -22779,10 +21999,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 316, - 320 - ] + "children": [316, 320] } ], "sources": [ @@ -22867,10 +22084,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 324, - 325 - ] + "children": [324, 325] } ], "sources": [ @@ -22907,10 +22121,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322, - 326 - ] + "children": [322, 326] } ], "sources": [ @@ -22998,10 +22209,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 719, - 720 - ] + "children": [719, 720] } ], "sources": [ @@ -23173,9 +22381,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 331 - ] + "children": [331] } ], "sources": [ @@ -23211,10 +22417,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 329, - 332 - ] + "children": [329, 332] } ], "sources": [ @@ -23277,10 +22480,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 334, - 335 - ] + "children": [334, 335] } ], "sources": [ @@ -23451,11 +22651,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 485, - 483, - 484 - ] + "children": [485, 483, 484] } ], "sources": [ @@ -23495,10 +22691,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 481, - 480 - ] + "children": [481, 480] } ], "sources": [ @@ -23633,10 +22826,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 454, - 453 - ] + "children": [454, 453] } ], "sources": [ @@ -23675,11 +22865,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 449, - 451, - 450 - ] + "children": [449, 451, 450] } ], "sources": [ @@ -23776,10 +22962,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 461, - 460 - ] + "children": [461, 460] } ], "sources": [ @@ -23839,11 +23022,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 458, - 457, - 456 - ] + "children": [458, 457, 456] } ], "sources": [ @@ -24026,12 +23205,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 470, - 469, - 467, - 468 - ] + "children": [470, 469, 467, 468] } ], "sources": [ @@ -24049,10 +23223,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 464, - 465 - ] + "children": [464, 465] } ], "sources": [ @@ -24172,11 +23343,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 477, - 476, - 475 - ] + "children": [477, 476, 475] } ], "sources": [ @@ -24215,10 +23382,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 473, - 472 - ] + "children": [473, 472] } ], "sources": [ @@ -24333,10 +23497,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 513, - 512 - ] + "children": [513, 512] } ], "sources": [ @@ -24354,9 +23515,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 510 - ] + "children": [510] } ], "sources": [ @@ -24406,9 +23565,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 515 - ] + "children": [515] } ], "sources": [ @@ -24455,9 +23612,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 517 - ] + "children": [517] } ], "sources": [ @@ -24619,11 +23774,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 439, - 438, - 437 - ] + "children": [439, 438, 437] } ], "sources": [ @@ -24662,11 +23813,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 433, - 435, - 434 - ] + "children": [433, 435, 434] } ], "sources": [ @@ -24763,10 +23910,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 446, - 445 - ] + "children": [446, 445] } ], "sources": [ @@ -24826,11 +23970,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 443, - 442, - 441 - ] + "children": [443, 442, 441] } ], "sources": [ @@ -24967,9 +24107,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 340 - ] + "children": [340] } ], "sources": [ @@ -25005,10 +24143,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 338, - 341 - ] + "children": [338, 341] } ], "sources": [ @@ -25074,9 +24209,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 345 - ] + "children": [345] } ], "sources": [ @@ -25113,10 +24246,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 343, - 346 - ] + "children": [343, 346] } ], "sources": [ @@ -25235,10 +24365,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -25313,12 +24440,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -25432,10 +24554,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -25489,12 +24608,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -25605,98 +24719,28 @@ { "title": "Classes", "kind": 128, - "children": [ - 732, - 727, - 792, - 779, - 817, - 767, - 745, - 752, - 1, - 75 - ] + "children": [732, 727, 792, 779, 817, 767, 745, 752, 1, 75] }, { "title": "Interfaces", "kind": 256, "children": [ - 356, - 411, - 370, - 540, - 699, - 654, - 347, - 421, - 429, - 384, - 377, - 406, - 359, - 381, - 498, - 490 + 356, 411, 370, 540, 699, 654, 347, 421, 429, 384, 377, 406, 359, 381, 498, 490 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 287, - 286, - 683, - 674, - 696, - 687, - 622, - 598, - 643, - 632, - 613, - 585, - 301, - 642, - 710, - 507, - 534, - 524, - 543, - 557, - 544, - 564, - 529, - 518, - 288, - 707, - 581, - 578, - 565, - 570, - 573, - 506, - 314, - 717, - 285, - 327, - 478, - 447, - 462, - 508, - 431, - 706, - 336, - 489 + 287, 286, 683, 674, 696, 687, 622, 598, 643, 632, 613, 585, 301, 642, 710, 507, 534, + 524, 543, 557, 544, 564, 529, 518, 288, 707, 581, 578, 565, 570, 573, 506, 314, 717, + 285, 327, 478, 447, 462, 508, 431, 706, 336, 489 ] }, { "title": "Functions", "kind": 64, - "children": [ - 724, - 721 - ] + "children": [724, 721] } ], "sources": [ @@ -25784,32 +24828,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -26453,32 +25482,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -26859,11 +25873,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 12, - 10, - 11 - ] + "children": [12, 10, 11] } ] } @@ -27421,10 +26431,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 45, - 44 - ] + "children": [45, 44] } ] } @@ -27542,27 +26549,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 20, - 18, - 19, - 17 - ] + "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, - "children": [ - 25, - 36 - ] + "children": [25, 36] } ], "sources": [ @@ -28436,32 +27433,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -29816,14 +28798,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 360, - 363, - 365, - 362, - 361, - 364 - ] + "children": [360, 363, 365, 362, 361, 364] } ] } @@ -31370,9 +30345,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 337 - ] + "children": [337] } ] } @@ -32400,9 +31373,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 300 - ] + "children": [300] } ] } @@ -32583,11 +31554,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322, - 324, - 323 - ] + "children": [322, 324, 323] } ] } @@ -32739,11 +31706,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 329, - 331, - 330 - ] + "children": [329, 331, 330] } ] } @@ -33072,9 +32035,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 344 - ] + "children": [344] } ] } @@ -34353,10 +33314,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 270, - 271 - ] + "children": [270, 271] } ] } @@ -34508,10 +33466,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 277, - 278 - ] + "children": [277, 278] } ] } @@ -34851,66 +33806,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 113 - ] + "children": [113] }, { "title": "Properties", "kind": 1024, - "children": [ - 383, - 375, - 378, - 373, - 371, - 374, - 376, - 377, - 372 - ] + "children": [383, 375, 378, 373, 371, 374, 376, 377, 372] }, { "title": "Methods", "kind": 2048, "children": [ - 345, - 207, - 199, - 352, - 119, - 356, - 301, - 354, - 135, - 143, - 175, - 191, - 183, - 167, - 332, - 151, - 159, - 279, - 350, - 127, - 285, - 295, - 316, - 255, - 338, - 247, - 215, - 223, - 231, - 239, - 368, - 366, - 311, - 348, - 263, - 386, - 384 + 345, 207, 199, 352, 119, 356, 301, 354, 135, 143, 175, 191, 183, 167, 332, 151, 159, + 279, 350, 127, 285, 295, 316, 255, 338, 247, 215, 223, 231, 239, 368, 366, 311, 348, + 263, 386, 384 ] } ], @@ -35225,11 +34134,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 59, - 57, - 58 - ] + "children": [59, 57, 58] } ] } @@ -35523,9 +34428,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 109 - ] + "children": [109] } ] } @@ -35702,9 +34605,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 88 - ] + "children": [88] } ] } @@ -35920,10 +34821,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 80 - ] + "children": [81, 80] } ] } @@ -36089,9 +34987,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 104 - ] + "children": [104] } ] } @@ -36314,11 +35210,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 97, - 96, - 95 - ] + "children": [97, 96, 95] } ] } @@ -36362,31 +35254,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 50 - ] + "children": [50] }, { "title": "Properties", "kind": 1024, - "children": [ - 68, - 65, - 66, - 67, - 64 - ] + "children": [68, 65, 66, 67, 64] }, { "title": "Methods", "kind": 2048, - "children": [ - 105, - 82, - 73, - 98, - 89 - ] + "children": [105, 82, 73, 98, 89] } ], "sources": [ @@ -37163,32 +36041,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -37917,14 +36780,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 457, - 460, - 462, - 459, - 458, - 461 - ] + "children": [457, 460, 462, 459, 458, 461] } ] } @@ -38132,9 +36988,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 434 - ] + "children": [434] } ] } @@ -38362,11 +37216,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 419, - 421, - 420 - ] + "children": [419, 421, 420] } ] } @@ -38513,11 +37363,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 426, - 428, - 427 - ] + "children": [426, 428, 427] } ] } @@ -38648,9 +37494,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 441 - ] + "children": [441] } ] } @@ -39261,44 +38105,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 402 - ] + "children": [402] }, { "title": "Properties", "kind": 1024, - "children": [ - 480, - 472, - 475, - 470, - 468, - 471, - 473, - 474, - 469 - ] + "children": [480, 472, 475, 470, 468, 471, 473, 474, 469] }, { "title": "Methods", "kind": 2048, - "children": [ - 442, - 449, - 453, - 451, - 429, - 447, - 413, - 435, - 465, - 463, - 408, - 445, - 483, - 481 - ] + "children": [442, 449, 453, 451, 429, 447, 413, 435, 465, 463, 408, 445, 483, 481] } ], "sources": [ @@ -39476,12 +38293,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 542, - 540, - 541, - 539 - ] + "children": [542, 540, 541, 539] } ], "sources": [ @@ -39562,10 +38374,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } }, { @@ -39592,10 +38401,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } } ], @@ -39603,23 +38409,12 @@ { "title": "Classes", "kind": 128, - "children": [ - 498, - 1, - 112, - 49, - 401 - ] + "children": [498, 1, 112, 49, 401] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 537, - 535, - 531, - 533 - ] + "children": [537, 535, 531, 533] } ], "sources": [ @@ -39707,11 +38502,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 501, - 503, - 502 - ] + "children": [501, 503, 502] } ], "sources": [ @@ -39810,12 +38601,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 505, - 508, - 506, - 507 - ] + "children": [505, 508, 506, 507] } ], "sources": [ @@ -39895,11 +38681,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 511, - 512, - 510 - ] + "children": [511, 512, 510] } ], "sources": [ @@ -39998,12 +38780,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 517, - 516, - 514, - 515 - ] + "children": [517, 516, 514, 515] } ], "sources": [ @@ -40182,10 +38959,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -40250,9 +39024,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -40270,10 +39042,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -40291,9 +39060,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -40666,15 +39433,7 @@ "title": "Properties", "kind": 1024, "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 + 425, 424, 427, 422, 423, 431, 426, 421, 420 ] } ], @@ -41294,12 +40053,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -41502,10 +40256,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -41570,9 +40321,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -41590,10 +40339,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -41611,9 +40357,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -42045,13 +40789,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -42167,40 +40905,19 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 + 71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -42290,54 +41007,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, + 326, 332, 328, 327, 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 - ] + "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] } ], "sources": [ @@ -42526,12 +41209,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -42797,9 +41475,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -42883,10 +41559,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -42988,9 +41661,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -43089,9 +41760,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -43204,9 +41873,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -43456,12 +42123,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -43727,12 +42389,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -43998,12 +42655,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -44269,12 +42921,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -44436,9 +43083,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -44985,40 +43630,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -45375,17 +43997,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 - ] + "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] } ], "sources": [ @@ -46004,12 +44616,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -46212,10 +44819,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -46280,9 +44884,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -46300,10 +44902,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -46321,9 +44920,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -46755,13 +45352,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -47031,10 +45622,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -47099,9 +45687,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -47119,10 +45705,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -47140,9 +45723,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -47179,52 +45760,22 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, + 343, 329, 318, 326, 332, 328, 327, 334, 335, 336, + 322, 323 ] }, { "title": "Methods", "kind": 2048, "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, + 366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373 ] } @@ -47415,12 +45966,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -47686,9 +46232,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -47772,10 +46316,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -47877,9 +46418,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -47978,9 +46517,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -48093,9 +46630,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -48345,12 +46880,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -48616,12 +47146,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -48887,12 +47412,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -49158,12 +47678,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -49325,9 +47840,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -49874,40 +48387,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -49997,54 +48487,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, 326, 332, 328, 327, + 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 - ] + "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] } ], "sources": [ @@ -50267,10 +48723,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -50335,9 +48788,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -50355,10 +48806,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -50376,9 +48824,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -50751,15 +49197,8 @@ "title": "Properties", "kind": 1024, "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 + 425, 424, 427, 422, 423, 431, + 426, 421, 420 ] } ], @@ -51379,12 +49818,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -51588,8 +50022,7 @@ "title": "Properties", "kind": 1024, "children": [ - 301, - 300 + 301, 300 ] } ], @@ -51655,9 +50088,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -51675,10 +50106,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -51696,9 +50124,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -52131,11 +50557,7 @@ "title": "Properties", "kind": 1024, "children": [ - 438, - 441, - 439, - 440, - 437 + 438, 441, 439, 440, 437 ] } ], @@ -52318,52 +50740,22 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, + 343, 329, 318, 326, 332, 328, 327, 334, 335, 336, + 322, 323 ] }, { "title": "Methods", "kind": 2048, "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, + 366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373 ] } @@ -52554,12 +50946,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -52825,9 +51212,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -52911,10 +51296,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -53016,9 +51398,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -53117,9 +51497,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -53232,9 +51610,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -53484,12 +51860,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -53755,12 +52126,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -54026,12 +52392,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -54297,12 +52658,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -54464,9 +52820,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -55013,40 +53367,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -55180,17 +53511,12 @@ { "title": "Properties", "kind": 1024, - "children": [ - 37, - 38 - ] + "children": [37, 38] }, { "title": "Methods", "kind": 2048, - "children": [ - 39 - ] + "children": [39] } ] } @@ -55286,20 +53612,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 28 - ] + "children": [28] }, { "title": "Properties", "kind": 1024, - "children": [ - 35, - 41, - 34, - 33, - 32 - ] + "children": [35, 41, 34, 33, 32] } ], "sources": [ @@ -55426,10 +53744,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -55494,9 +53809,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -55514,10 +53827,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -55535,9 +53845,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -55870,17 +54178,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 - ] + "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] } ], "sources": [ @@ -56012,13 +54310,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -56148,12 +54440,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -56392,11 +54679,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 456, - 457, - 458 - ] + "children": [456, 457, 458] } ], "sources": [ @@ -56568,11 +54851,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 466, - 467, - 468 - ] + "children": [466, 467, 468] } ], "sources": [ @@ -56756,11 +55035,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 475, - 476, - 478 - ] + "children": [475, 476, 478] } ], "sources": [ @@ -56947,11 +55222,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 475, - 476, - 478 - ] + "children": [475, 476, 478] } ], "sources": [ @@ -57127,11 +55398,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 456, - 457, - 458 - ] + "children": [456, 457, 458] } ], "sources": [ @@ -57303,11 +55570,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 466, - 467, - 468 - ] + "children": [466, 467, 468] } ], "sources": [ @@ -57437,12 +55700,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 487, - 485, - 486, - 488 - ] + "children": [487, 485, 486, 488] } ], "sources": [ @@ -57570,12 +55828,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 493, - 491, - 492, - 494 - ] + "children": [493, 491, 492, 494] } ], "sources": [ @@ -57681,40 +55934,17 @@ { "title": "Enumerations", "kind": 8, - "children": [ - 500, - 504, - 509, - 513 - ] + "children": [500, 504, 509, 513] }, { "title": "Classes", "kind": 128, - "children": [ - 55, - 306, - 1 - ] + "children": [55, 306, 1] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 294, - 305, - 418, - 435, - 442, - 449, - 473, - 454, - 464, - 483, - 489, - 495, - 499 - ] + "children": [294, 305, 418, 435, 442, 449, 473, 454, 464, 483, 489, 495, 499] } ], "sources": [ @@ -57740,14 +55970,14 @@ "flags": {}, "children": [ { - "id": 390, + "id": 402, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 391, + "id": 403, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -57761,14 +55991,14 @@ ], "signatures": [ { - "id": 392, + "id": 404, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 393, + "id": 405, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -57779,7 +56009,7 @@ } }, { - "id": 394, + "id": 406, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -57792,24 +56022,24 @@ ], "type": { "type": "reference", - "id": 390, + "id": 402, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 387, + "id": 399, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 386, + "id": 398, "name": "StorageError.constructor" } }, { - "id": 395, + "id": 407, "name": "status", "kind": 1024, "kindString": "Property", @@ -57827,7 +56057,7 @@ } }, { - "id": 396, + "id": 408, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -57841,7 +56071,7 @@ ], "signatures": [ { - "id": 397, + "id": 409, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -57849,14 +56079,14 @@ "type": { "type": "reflection", "declaration": { - "id": 398, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 400, + "id": 412, "name": "message", "kind": 1024, "kindString": "Property", @@ -57875,7 +56105,7 @@ "defaultValue": "..." }, { - "id": 399, + "id": 411, "name": "name", "kind": 1024, "kindString": "Property", @@ -57894,7 +56124,7 @@ "defaultValue": "..." }, { - "id": 401, + "id": 413, "name": "status", "kind": 1024, "kindString": "Property", @@ -57917,11 +56147,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 400, - 399, - 401 - ] + "children": [412, 411, 413] } ] } @@ -57934,23 +56160,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 391 - ] + "children": [403] }, { "title": "Properties", "kind": 1024, - "children": [ - 395 - ] + "children": [407] }, { "title": "Methods", "kind": 2048, - "children": [ - 396 - ] + "children": [408] } ], "sources": [ @@ -57963,20 +56183,20 @@ "extendedTypes": [ { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } ] }, { - "id": 258, + "id": 266, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 259, + "id": 267, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -57990,14 +56210,14 @@ ], "signatures": [ { - "id": 260, + "id": 268, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 261, + "id": 269, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -58008,7 +56228,7 @@ } }, { - "id": 262, + "id": 270, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -58016,20 +56236,20 @@ "type": { "type": "reflection", "declaration": { - "id": 263, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 264, + "id": 272, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 265, + "id": 273, "name": "key", "kind": 32768, "flags": {}, @@ -58049,7 +56269,7 @@ "defaultValue": "{}" }, { - "id": 266, + "id": 274, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -58059,21 +56279,21 @@ "type": { "type": "reflection", "declaration": { - "id": 267, + "id": 275, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 268, + "id": 276, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 269, + "id": 277, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -58086,7 +56306,7 @@ } }, { - "id": 270, + "id": 278, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -58123,7 +56343,7 @@ ], "type": { "type": "reference", - "id": 258, + "id": 266, "name": "StorageClient" }, "overwrites": { @@ -58140,7 +56360,7 @@ } }, { - "id": 301, + "id": 309, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -58154,7 +56374,7 @@ ], "signatures": [ { - "id": 302, + "id": 310, "name": "createBucket", "kind": 4096, "kindString": "Call signature", @@ -58165,7 +56385,7 @@ }, "parameters": [ { - "id": 303, + "id": 311, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -58179,7 +56399,7 @@ } }, { - "id": 304, + "id": 312, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -58187,14 +56407,14 @@ "type": { "type": "reflection", "declaration": { - "id": 305, + "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 306, + "id": 314, "name": "public", "kind": 1024, "kindString": "Property", @@ -58219,9 +56439,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 306 - ] + "children": [314] } ] } @@ -58238,14 +56456,14 @@ { "type": "reflection", "declaration": { - "id": 307, + "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 308, + "id": 316, "name": "data", "kind": 1024, "kindString": "Property", @@ -58262,7 +56480,7 @@ "typeArguments": [ { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" }, { @@ -58276,7 +56494,7 @@ } }, { - "id": 309, + "id": 317, "name": "error", "kind": 1024, "kindString": "Property", @@ -58298,10 +56516,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 308, - 309 - ] + "children": [316, 317] } ] } @@ -58309,14 +56524,14 @@ { "type": "reflection", "declaration": { - "id": 310, + "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 311, + "id": 319, "name": "data", "kind": 1024, "kindString": "Property", @@ -58334,7 +56549,7 @@ } }, { - "id": 312, + "id": 320, "name": "error", "kind": 1024, "kindString": "Property", @@ -58348,7 +56563,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -58357,10 +56572,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 311, - 312 - ] + "children": [319, 320] } ] } @@ -58386,7 +56598,7 @@ } }, { - "id": 338, + "id": 346, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -58400,7 +56612,7 @@ ], "signatures": [ { - "id": 339, + "id": 347, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", @@ -58410,7 +56622,7 @@ }, "parameters": [ { - "id": 340, + "id": 348, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -58433,14 +56645,14 @@ { "type": "reflection", "declaration": { - "id": 341, + "id": 349, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 350, "name": "data", "kind": 1024, "kindString": "Property", @@ -58455,14 +56667,14 @@ "type": { "type": "reflection", "declaration": { - "id": 343, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 344, + "id": 352, "name": "message", "kind": 1024, "kindString": "Property", @@ -58484,16 +56696,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 344 - ] + "children": [352] } ] } } }, { - "id": 345, + "id": 353, "name": "error", "kind": 1024, "kindString": "Property", @@ -58515,10 +56725,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 342, - 345 - ] + "children": [350, 353] } ] } @@ -58526,14 +56733,14 @@ { "type": "reflection", "declaration": { - "id": 346, + "id": 354, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 347, + "id": 355, "name": "data", "kind": 1024, "kindString": "Property", @@ -58551,7 +56758,7 @@ } }, { - "id": 348, + "id": 356, "name": "error", "kind": 1024, "kindString": "Property", @@ -58565,7 +56772,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -58574,10 +56781,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 347, - 348 - ] + "children": [355, 356] } ] } @@ -58603,7 +56807,7 @@ } }, { - "id": 327, + "id": 335, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -58617,7 +56821,7 @@ ], "signatures": [ { - "id": 328, + "id": 336, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", @@ -58627,7 +56831,7 @@ }, "parameters": [ { - "id": 329, + "id": 337, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -58650,14 +56854,14 @@ { "type": "reflection", "declaration": { - "id": 330, + "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 331, + "id": 339, "name": "data", "kind": 1024, "kindString": "Property", @@ -58672,14 +56876,14 @@ "type": { "type": "reflection", "declaration": { - "id": 332, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 333, + "id": 341, "name": "message", "kind": 1024, "kindString": "Property", @@ -58701,16 +56905,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 333 - ] + "children": [341] } ] } } }, { - "id": 334, + "id": 342, "name": "error", "kind": 1024, "kindString": "Property", @@ -58732,10 +56934,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 331, - 334 - ] + "children": [339, 342] } ] } @@ -58743,14 +56942,14 @@ { "type": "reflection", "declaration": { - "id": 335, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 344, "name": "data", "kind": 1024, "kindString": "Property", @@ -58768,7 +56967,7 @@ } }, { - "id": 337, + "id": 345, "name": "error", "kind": 1024, "kindString": "Property", @@ -58782,7 +56981,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -58791,10 +56990,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 336, - 337 - ] + "children": [344, 345] } ] } @@ -58820,7 +57016,7 @@ } }, { - "id": 271, + "id": 279, "name": "from", "kind": 2048, "kindString": "Method", @@ -58834,7 +57030,7 @@ ], "signatures": [ { - "id": 272, + "id": 280, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -58844,7 +57040,7 @@ }, "parameters": [ { - "id": 273, + "id": 281, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -58867,7 +57063,7 @@ ] }, { - "id": 292, + "id": 300, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -58881,7 +57077,7 @@ ], "signatures": [ { - "id": 293, + "id": 301, "name": "getBucket", "kind": 4096, "kindString": "Call signature", @@ -58891,7 +57087,7 @@ }, "parameters": [ { - "id": 294, + "id": 302, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -58914,14 +57110,14 @@ { "type": "reflection", "declaration": { - "id": 295, + "id": 303, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 296, + "id": 304, "name": "data", "kind": 1024, "kindString": "Property", @@ -58935,12 +57131,12 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, { - "id": 297, + "id": 305, "name": "error", "kind": 1024, "kindString": "Property", @@ -58962,10 +57158,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296, - 297 - ] + "children": [304, 305] } ] } @@ -58973,14 +57166,14 @@ { "type": "reflection", "declaration": { - "id": 298, + "id": 306, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 299, + "id": 307, "name": "data", "kind": 1024, "kindString": "Property", @@ -58998,7 +57191,7 @@ } }, { - "id": 300, + "id": 308, "name": "error", "kind": 1024, "kindString": "Property", @@ -59012,7 +57205,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -59021,10 +57214,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 299, - 300 - ] + "children": [307, 308] } ] } @@ -59050,7 +57240,7 @@ } }, { - "id": 284, + "id": 292, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -59064,7 +57254,7 @@ ], "signatures": [ { - "id": 285, + "id": 293, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", @@ -59081,14 +57271,14 @@ { "type": "reflection", "declaration": { - "id": 286, + "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 295, "name": "data", "kind": 1024, "kindString": "Property", @@ -59104,13 +57294,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } } }, { - "id": 288, + "id": 296, "name": "error", "kind": 1024, "kindString": "Property", @@ -59132,10 +57322,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 287, - 288 - ] + "children": [295, 296] } ] } @@ -59143,14 +57330,14 @@ { "type": "reflection", "declaration": { - "id": 289, + "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 290, + "id": 298, "name": "data", "kind": 1024, "kindString": "Property", @@ -59168,7 +57355,7 @@ } }, { - "id": 291, + "id": 299, "name": "error", "kind": 1024, "kindString": "Property", @@ -59182,7 +57369,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -59191,10 +57378,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 290, - 291 - ] + "children": [298, 299] } ] } @@ -59220,7 +57404,7 @@ } }, { - "id": 313, + "id": 321, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -59234,7 +57418,7 @@ ], "signatures": [ { - "id": 314, + "id": 322, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", @@ -59244,7 +57428,7 @@ }, "parameters": [ { - "id": 315, + "id": 323, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -59258,7 +57442,7 @@ } }, { - "id": 316, + "id": 324, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -59266,14 +57450,14 @@ "type": { "type": "reflection", "declaration": { - "id": 317, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 318, + "id": 326, "name": "public", "kind": 1024, "kindString": "Property", @@ -59298,9 +57482,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 318 - ] + "children": [326] } ] } @@ -59316,14 +57498,14 @@ { "type": "reflection", "declaration": { - "id": 319, + "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 320, + "id": 328, "name": "data", "kind": 1024, "kindString": "Property", @@ -59338,14 +57520,14 @@ "type": { "type": "reflection", "declaration": { - "id": 321, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 322, + "id": 330, "name": "message", "kind": 1024, "kindString": "Property", @@ -59367,16 +57549,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322 - ] + "children": [330] } ] } } }, { - "id": 323, + "id": 331, "name": "error", "kind": 1024, "kindString": "Property", @@ -59398,10 +57578,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 320, - 323 - ] + "children": [328, 331] } ] } @@ -59409,14 +57586,14 @@ { "type": "reflection", "declaration": { - "id": 324, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 325, + "id": 333, "name": "data", "kind": 1024, "kindString": "Property", @@ -59434,7 +57611,7 @@ } }, { - "id": 326, + "id": 334, "name": "error", "kind": 1024, "kindString": "Property", @@ -59448,7 +57625,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -59457,10 +57634,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 325, - 326 - ] + "children": [333, 334] } ] } @@ -59490,22 +57664,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 259 - ] + "children": [267] }, { "title": "Methods", "kind": 2048, - "children": [ - 301, - 338, - 327, - 271, - 292, - 284, - 313 - ] + "children": [309, 346, 335, 279, 300, 292, 321] } ], "sources": [ @@ -59524,14 +57688,14 @@ ] }, { - "id": 385, + "id": 397, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 386, + "id": 398, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -59545,14 +57709,14 @@ ], "signatures": [ { - "id": 387, + "id": 399, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 388, + "id": 400, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -59565,7 +57729,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" }, "overwrites": { @@ -59584,9 +57748,7 @@ { "title": "Constructors", "kind": 512, - "children": [ - 386 - ] + "children": [398] } ], "sources": [ @@ -59607,25 +57769,25 @@ "extendedBy": [ { "type": "reference", - "id": 390, + "id": 402, "name": "StorageApiError" }, { "type": "reference", - "id": 403, + "id": 415, "name": "StorageUnknownError" } ] }, { - "id": 403, + "id": 415, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 404, + "id": 416, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -59639,14 +57801,14 @@ ], "signatures": [ { - "id": 405, + "id": 417, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 406, + "id": 418, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -59657,7 +57819,7 @@ } }, { - "id": 407, + "id": 419, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -59670,24 +57832,24 @@ ], "type": { "type": "reference", - "id": 403, + "id": 415, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 387, + "id": 399, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 386, + "id": 398, "name": "StorageError.constructor" } }, { - "id": 408, + "id": 420, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -59709,16 +57871,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 404 - ] + "children": [416] }, { "title": "Properties", "kind": 1024, - "children": [ - 408 - ] + "children": [420] } ], "sources": [ @@ -59731,20 +57889,20 @@ "extendedTypes": [ { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } ] }, { - "id": 349, + "id": 357, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 353, + "id": 361, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -59762,7 +57920,7 @@ } }, { - "id": 350, + "id": 358, "name": "id", "kind": 1024, "kindString": "Property", @@ -59780,7 +57938,7 @@ } }, { - "id": 351, + "id": 359, "name": "name", "kind": 1024, "kindString": "Property", @@ -59798,7 +57956,7 @@ } }, { - "id": 352, + "id": 360, "name": "owner", "kind": 1024, "kindString": "Property", @@ -59816,7 +57974,7 @@ } }, { - "id": 355, + "id": 363, "name": "public", "kind": 1024, "kindString": "Property", @@ -59834,7 +57992,7 @@ } }, { - "id": 354, + "id": 362, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -59856,14 +58014,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 353, - 350, - 351, - 352, - 355, - 354 - ] + "children": [361, 358, 359, 360, 363, 362] } ], "sources": [ @@ -59875,14 +58026,14 @@ ] }, { - "id": 378, + "id": 386, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 379, + "id": 387, "name": "signal", "kind": 1024, "kindString": "Property", @@ -59911,9 +58062,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 379 - ] + "children": [387] } ], "sources": [ @@ -59925,14 +58074,14 @@ ] }, { - "id": 356, + "id": 364, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 358, + "id": 366, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -59950,7 +58099,7 @@ } }, { - "id": 365, + "id": 373, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -59964,12 +58113,12 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, { - "id": 362, + "id": 370, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -59987,7 +58136,7 @@ } }, { - "id": 360, + "id": 368, "name": "id", "kind": 1024, "kindString": "Property", @@ -60005,7 +58154,7 @@ } }, { - "id": 363, + "id": 371, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -60023,7 +58172,7 @@ } }, { - "id": 364, + "id": 372, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -60053,7 +58202,7 @@ } }, { - "id": 357, + "id": 365, "name": "name", "kind": 1024, "kindString": "Property", @@ -60071,7 +58220,7 @@ } }, { - "id": 359, + "id": 367, "name": "owner", "kind": 1024, "kindString": "Property", @@ -60089,7 +58238,7 @@ } }, { - "id": 361, + "id": 369, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -60111,17 +58260,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 358, - 365, - 362, - 360, - 363, - 364, - 357, - 359, - 361 - ] + "children": [366, 373, 370, 368, 371, 372, 365, 367, 369] } ], "sources": [ @@ -60133,14 +58272,14 @@ ] }, { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -60163,7 +58302,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -60186,7 +58325,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -60213,11 +58352,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -60229,14 +58364,14 @@ ] }, { - "id": 380, + "id": 388, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 381, + "id": 389, "name": "name", "kind": 1024, "kindString": "Property", @@ -60258,9 +58393,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 381 - ] + "children": [389] } ], "sources": [ @@ -60272,14 +58405,14 @@ ] }, { - "id": 373, + "id": 381, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 374, + "id": 382, "name": "limit", "kind": 1024, "kindString": "Property", @@ -60302,7 +58435,7 @@ } }, { - "id": 375, + "id": 383, "name": "offset", "kind": 1024, "kindString": "Property", @@ -60325,7 +58458,7 @@ } }, { - "id": 377, + "id": 385, "name": "search", "kind": 1024, "kindString": "Property", @@ -60348,7 +58481,7 @@ } }, { - "id": 376, + "id": 384, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -60367,7 +58500,7 @@ ], "type": { "type": "reference", - "id": 366, + "id": 374, "name": "SortBy" } } @@ -60376,12 +58509,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 374, - 375, - 377, - 376 - ] + "children": [382, 383, 385, 384] } ], "sources": [ @@ -60393,14 +58521,14 @@ ] }, { - "id": 366, + "id": 374, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 367, + "id": 375, "name": "column", "kind": 1024, "kindString": "Property", @@ -60420,7 +58548,7 @@ } }, { - "id": 368, + "id": 376, "name": "order", "kind": 1024, "kindString": "Property", @@ -60444,10 +58572,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 367, - 368 - ] + "children": [375, 376] } ], "sources": [ @@ -60459,7 +58584,112 @@ ] }, { - "id": 382, + "id": 390, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 392, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The height of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "name": "resize", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "cover" + }, + { + "type": "literal", + "value": "contain" + }, + { + "type": "literal", + "value": "fill" + } + ] + } + }, + { + "id": 391, + "name": "width", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The width of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [392, 393, 391] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 17 + } + ] + }, + { + "id": 394, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -60473,14 +58703,14 @@ ], "signatures": [ { - "id": 383, + "id": 395, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 384, + "id": 396, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -60497,7 +58727,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -60509,32 +58739,17 @@ { "title": "Classes", "kind": 128, - "children": [ - 390, - 258, - 385, - 403 - ] + "children": [402, 266, 397, 415] }, { "title": "Interfaces", "kind": 256, - "children": [ - 349, - 378, - 356, - 369, - 380, - 373, - 366 - ] + "children": [357, 386, 364, 377, 388, 381, 374, 390] }, { "title": "Functions", "kind": 64, - "children": [ - 382 - ] + "children": [394] } ], "sources": [ @@ -60793,9 +59008,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 48 - ] + "children": [48] } ] } @@ -60836,7 +59049,7 @@ "typeArguments": [ { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" }, { @@ -60872,10 +59085,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 50, - 51 - ] + "children": [50, 51] } ] } @@ -60922,7 +59132,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -60931,10 +59141,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 53, - 54 - ] + "children": [53, 54] } ] } @@ -61048,9 +59255,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 86 - ] + "children": [86] } ] } @@ -61079,10 +59284,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 84, - 87 - ] + "children": [84, 87] } ] } @@ -61129,7 +59331,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -61138,10 +59340,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 89, - 90 - ] + "children": [89, 90] } ] } @@ -61255,9 +59454,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 75 - ] + "children": [75] } ] } @@ -61286,10 +59483,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 73, - 76 - ] + "children": [73, 76] } ] } @@ -61336,7 +59530,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -61345,10 +59539,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 78, - 79 - ] + "children": [78, 79] } ] } @@ -61432,7 +59623,7 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, @@ -61459,10 +59650,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 38, - 39 - ] + "children": [38, 39] } ] } @@ -61509,7 +59697,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -61518,10 +59706,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 41, - 42 - ] + "children": [41, 42] } ] } @@ -61591,7 +59776,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } } @@ -61619,10 +59804,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 29, - 30 - ] + "children": [29, 30] } ] } @@ -61669,7 +59851,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -61678,10 +59860,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 32, - 33 - ] + "children": [32, 33] } ] } @@ -61775,9 +59954,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 60 - ] + "children": [60] } ] } @@ -61844,9 +60021,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 64 - ] + "children": [64] } ] } @@ -61875,10 +60050,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 62, - 65 - ] + "children": [62, 65] } ] } @@ -61925,7 +60097,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -61934,10 +60106,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 67, - 68 - ] + "children": [67, 68] } ] } @@ -61957,21 +60126,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 4 - ] + "children": [4] }, { "title": "Methods", "kind": 2048, - "children": [ - 43, - 80, - 69, - 34, - 26, - 55 - ] + "children": [43, 80, 69, 34, 26, 55] } ], "sources": [ @@ -61984,7 +60144,7 @@ "extendedBy": [ { "type": "reference", - "id": 258, + "id": 266, "name": "StorageClient" } ] @@ -61994,9 +60154,7 @@ { "title": "Classes", "kind": 128, - "children": [ - 3 - ] + "children": [3] } ], "sources": [ @@ -62030,7 +60188,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 27, + "line": 33, "character": 2 } ], @@ -62197,7 +60355,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 226, + "line": 232, "character": 8 } ], @@ -62265,7 +60423,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, + "line": 237, "character": 8 } ], @@ -62287,7 +60445,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, + "line": 237, "character": 16 } ], @@ -62301,9 +60459,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 176 - ] + "children": [176] } ] } @@ -62318,7 +60474,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 232, + "line": 238, "character": 8 } ], @@ -62332,10 +60488,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 174, - 177 - ] + "children": [174, 177] } ] } @@ -62358,7 +60511,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 235, + "line": 241, "character": 8 } ], @@ -62376,13 +60529,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 236, + "line": 242, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -62391,10 +60544,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 179, - 180 - ] + "children": [179, 180] } ] } @@ -62418,7 +60568,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 263, + "line": 270, "character": 8 } ], @@ -62483,14 +60633,16 @@ "name": "download", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 266, + "line": 273, "character": 16 } ], @@ -62507,15 +60659,37 @@ } ] } + }, + { + "id": 188, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 273, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [ - 187 - ] + "children": [187, 188] } ] } @@ -62531,14 +60705,14 @@ { "type": "reflection", "declaration": { - "id": 188, + "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 189, + "id": 190, "name": "data", "kind": 1024, "kindString": "Property", @@ -62546,21 +60720,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 276, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 190, + "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 191, + "id": 192, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -62568,7 +60742,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 276, "character": 16 } ], @@ -62582,16 +60756,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 191 - ] + "children": [192] } ] } } }, { - "id": 192, + "id": 193, "name": "error", "kind": 1024, "kindString": "Property", @@ -62599,7 +60771,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 270, + "line": 277, "character": 8 } ], @@ -62613,10 +60785,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 189, - 192 - ] + "children": [190, 193] } ] } @@ -62624,14 +60793,14 @@ { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 194, + "id": 195, "name": "data", "kind": 1024, "kindString": "Property", @@ -62639,7 +60808,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 273, + "line": 280, "character": 8 } ], @@ -62649,7 +60818,7 @@ } }, { - "id": 195, + "id": 196, "name": "error", "kind": 1024, "kindString": "Property", @@ -62657,13 +60826,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 274, + "line": 281, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -62672,10 +60841,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 194, - 195 - ] + "children": [195, 196] } ] } @@ -62691,7 +60857,7 @@ ] }, { - "id": 196, + "id": 197, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -62699,13 +60865,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 315, "character": 8 } ], "signatures": [ { - "id": 197, + "id": 198, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", @@ -62715,7 +60881,7 @@ }, "parameters": [ { - "id": 198, + "id": 199, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -62732,7 +60898,7 @@ } }, { - "id": 199, + "id": 200, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -62746,7 +60912,7 @@ } }, { - "id": 200, + "id": 201, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -62756,14 +60922,14 @@ "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 203, "name": "download", "kind": 1024, "kindString": "Property", @@ -62774,7 +60940,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 310, + "line": 318, "character": 16 } ], @@ -62797,9 +60963,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 202 - ] + "children": [203] } ] } @@ -62815,14 +60979,14 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 204, + "id": 205, "name": "data", "kind": 1024, "kindString": "Property", @@ -62830,7 +60994,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 8 } ], @@ -62839,14 +61003,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 205, + "id": 206, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 206, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -62854,7 +61018,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 16 } ], @@ -62873,7 +61037,7 @@ } }, { - "id": 207, + "id": 208, "name": "path", "kind": 1024, "kindString": "Property", @@ -62881,7 +61045,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 38 } ], @@ -62900,7 +61064,7 @@ } }, { - "id": 208, + "id": 209, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -62908,7 +61072,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 59 } ], @@ -62922,11 +61086,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 206, - 207, - 208 - ] + "children": [207, 208, 209] } ] } @@ -62934,7 +61094,7 @@ } }, { - "id": 209, + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -62942,7 +61102,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 314, + "line": 322, "character": 8 } ], @@ -62956,10 +61116,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 204, - 209 - ] + "children": [205, 210] } ] } @@ -62967,14 +61124,14 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 212, "name": "data", "kind": 1024, "kindString": "Property", @@ -62982,7 +61139,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 317, + "line": 325, "character": 8 } ], @@ -62992,7 +61149,7 @@ } }, { - "id": 212, + "id": 213, "name": "error", "kind": 1024, "kindString": "Property", @@ -63000,13 +61157,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, + "line": 326, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -63015,10 +61172,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 211, - 212 - ] + "children": [212, 213] } ] } @@ -63034,7 +61188,7 @@ ] }, { - "id": 213, + "id": 214, "name": "download", "kind": 2048, "kindString": "Method", @@ -63042,13 +61196,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 355, + "line": 364, "character": 8 } ], "signatures": [ { - "id": 214, + "id": 215, "name": "download", "kind": 4096, "kindString": "Call signature", @@ -63058,18 +61212,70 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`.\n" + "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 217, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 366, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } } ], "type": { @@ -63081,14 +61287,14 @@ { "type": "reflection", "declaration": { - "id": 216, + "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 217, + "id": 221, "name": "data", "kind": 1024, "kindString": "Property", @@ -63096,7 +61302,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 359, + "line": 369, "character": 8 } ], @@ -63108,7 +61314,7 @@ } }, { - "id": 218, + "id": 222, "name": "error", "kind": 1024, "kindString": "Property", @@ -63116,7 +61322,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 360, + "line": 370, "character": 8 } ], @@ -63130,10 +61336,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 217, - 218 - ] + "children": [221, 222] } ] } @@ -63141,14 +61344,14 @@ { "type": "reflection", "declaration": { - "id": 219, + "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 220, + "id": 224, "name": "data", "kind": 1024, "kindString": "Property", @@ -63156,7 +61359,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 363, + "line": 373, "character": 8 } ], @@ -63166,7 +61369,7 @@ } }, { - "id": 221, + "id": 225, "name": "error", "kind": 1024, "kindString": "Property", @@ -63174,13 +61377,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 364, + "line": 374, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -63189,10 +61392,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 220, - 221 - ] + "children": [224, 225] } ] } @@ -63208,7 +61408,7 @@ ] }, { - "id": 222, + "id": 226, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -63216,13 +61416,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 391, + "line": 407, "character": 2 } ], "signatures": [ { - "id": 223, + "id": 227, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", @@ -63232,7 +61432,7 @@ }, "parameters": [ { - "id": 224, + "id": 228, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -63246,7 +61446,7 @@ } }, { - "id": 225, + "id": 229, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -63256,25 +61456,27 @@ "type": { "type": "reflection", "declaration": { - "id": 226, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 227, + "id": 231, "name": "download", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 393, + "line": 409, "character": 16 } ], @@ -63291,15 +61493,37 @@ } ] } + }, + { + "id": 232, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 409, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [ - 227 - ] + "children": [231, 232] } ] } @@ -63309,14 +61533,14 @@ "type": { "type": "reflection", "declaration": { - "id": 228, + "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 229, + "id": 234, "name": "data", "kind": 1024, "kindString": "Property", @@ -63324,21 +61548,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 394, + "line": 410, "character": 7 } ], "type": { "type": "reflection", "declaration": { - "id": 230, + "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 231, + "id": 236, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -63346,7 +61570,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 394, + "line": 410, "character": 15 } ], @@ -63360,9 +61584,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 231 - ] + "children": [236] } ] } @@ -63373,9 +61595,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 229 - ] + "children": [234] } ] } @@ -63384,7 +61604,7 @@ ] }, { - "id": 241, + "id": 246, "name": "list", "kind": 2048, "kindString": "Method", @@ -63392,13 +61612,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 506, + "line": 541, "character": 8 } ], "signatures": [ { - "id": 242, + "id": 247, "name": "list", "kind": 4096, "kindString": "Call signature", @@ -63408,7 +61628,7 @@ }, "parameters": [ { - "id": 243, + "id": 248, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -63424,7 +61644,7 @@ } }, { - "id": 244, + "id": 249, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -63433,17 +61653,17 @@ }, "type": { "type": "reference", - "id": 373, + "id": 381, "name": "SearchOptions", "dereferenced": { - "id": 373, + "id": 381, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 374, + "id": 382, "name": "limit", "kind": 1024, "kindString": "Property", @@ -63466,7 +61686,7 @@ } }, { - "id": 375, + "id": 383, "name": "offset", "kind": 1024, "kindString": "Property", @@ -63489,7 +61709,7 @@ } }, { - "id": 377, + "id": 385, "name": "search", "kind": 1024, "kindString": "Property", @@ -63512,7 +61732,7 @@ } }, { - "id": 376, + "id": 384, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -63531,7 +61751,7 @@ ], "type": { "type": "reference", - "id": 366, + "id": 374, "name": "SortBy" } } @@ -63540,12 +61760,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 374, - 375, - 377, - 376 - ] + "children": [382, 383, 385, 384] } ], "sources": [ @@ -63559,7 +61774,7 @@ } }, { - "id": 245, + "id": 250, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -63568,17 +61783,17 @@ }, "type": { "type": "reference", - "id": 378, + "id": 386, "name": "FetchParameters", "dereferenced": { - "id": 378, + "id": 386, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 379, + "id": 387, "name": "signal", "kind": 1024, "kindString": "Property", @@ -63607,9 +61822,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 379 - ] + "children": [387] } ], "sources": [ @@ -63632,14 +61845,14 @@ { "type": "reflection", "declaration": { - "id": 246, + "id": 251, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 247, + "id": 252, "name": "data", "kind": 1024, "kindString": "Property", @@ -63647,7 +61860,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 512, + "line": 547, "character": 8 } ], @@ -63655,13 +61868,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 356, + "id": 364, "name": "FileObject" } } }, { - "id": 248, + "id": 253, "name": "error", "kind": 1024, "kindString": "Property", @@ -63669,7 +61882,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 513, + "line": 548, "character": 8 } ], @@ -63683,10 +61896,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 247, - 248 - ] + "children": [252, 253] } ] } @@ -63694,14 +61904,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 255, "name": "data", "kind": 1024, "kindString": "Property", @@ -63709,7 +61919,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 551, "character": 8 } ], @@ -63719,7 +61929,7 @@ } }, { - "id": 251, + "id": 256, "name": "error", "kind": 1024, "kindString": "Property", @@ -63727,13 +61937,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 517, + "line": 552, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -63742,10 +61952,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 250, - 251 - ] + "children": [255, 256] } ] } @@ -63769,7 +61976,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 190, + "line": 196, "character": 8 } ], @@ -63837,7 +62044,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 195, + "line": 201, "character": 8 } ], @@ -63859,7 +62066,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 195, + "line": 201, "character": 16 } ], @@ -63873,9 +62080,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 164 - ] + "children": [164] } ] } @@ -63890,7 +62095,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 196, + "line": 202, "character": 8 } ], @@ -63904,10 +62109,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 162, - 165 - ] + "children": [162, 165] } ] } @@ -63930,7 +62132,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 199, + "line": 205, "character": 8 } ], @@ -63948,13 +62150,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 200, + "line": 206, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -63963,10 +62165,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 167, - 168 - ] + "children": [167, 168] } ] } @@ -63982,7 +62181,7 @@ ] }, { - "id": 232, + "id": 237, "name": "remove", "kind": 2048, "kindString": "Method", @@ -63990,13 +62189,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 410, + "line": 445, "character": 8 } ], "signatures": [ { - "id": 233, + "id": 238, "name": "remove", "kind": 4096, "kindString": "Call signature", @@ -64006,7 +62205,7 @@ }, "parameters": [ { - "id": 234, + "id": 239, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -64032,14 +62231,14 @@ { "type": "reflection", "declaration": { - "id": 235, + "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 241, "name": "data", "kind": 1024, "kindString": "Property", @@ -64047,7 +62246,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 414, + "line": 449, "character": 8 } ], @@ -64055,13 +62254,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 356, + "id": 364, "name": "FileObject" } } }, { - "id": 237, + "id": 242, "name": "error", "kind": 1024, "kindString": "Property", @@ -64069,7 +62268,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 415, + "line": 450, "character": 8 } ], @@ -64083,10 +62282,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 236, - 237 - ] + "children": [241, 242] } ] } @@ -64094,14 +62290,14 @@ { "type": "reflection", "declaration": { - "id": 238, + "id": 243, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 239, + "id": 244, "name": "data", "kind": 1024, "kindString": "Property", @@ -64109,7 +62305,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 418, + "line": 453, "character": 8 } ], @@ -64119,7 +62315,7 @@ } }, { - "id": 240, + "id": 245, "name": "error", "kind": 1024, "kindString": "Property", @@ -64127,13 +62323,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 419, + "line": 454, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -64142,10 +62338,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 239, - 240 - ] + "children": [244, 245] } ] } @@ -64169,7 +62362,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 157, + "line": 163, "character": 8 } ], @@ -64289,17 +62482,17 @@ }, "type": { "type": "reference", - "id": 369, + "id": 377, "name": "FileOptions", "dereferenced": { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -64322,7 +62515,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -64345,7 +62538,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -64372,11 +62565,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -64414,7 +62603,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 173, + "line": 179, "character": 8 } ], @@ -64436,7 +62625,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 173, + "line": 179, "character": 16 } ], @@ -64450,9 +62639,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 152 - ] + "children": [152] } ] } @@ -64467,7 +62654,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 174, + "line": 180, "character": 8 } ], @@ -64481,10 +62668,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 150, - 153 - ] + "children": [150, 153] } ] } @@ -64507,7 +62691,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 177, + "line": 183, "character": 8 } ], @@ -64525,13 +62709,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 178, + "line": 184, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -64540,10 +62724,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155, - 156 - ] + "children": [155, 156] } ] } @@ -64567,7 +62748,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 124, + "line": 130, "character": 8 } ], @@ -64687,17 +62868,17 @@ }, "type": { "type": "reference", - "id": 369, + "id": 377, "name": "FileOptions", "dereferenced": { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -64720,7 +62901,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -64743,7 +62924,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -64770,11 +62951,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -64812,7 +62989,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 140, + "line": 146, "character": 8 } ], @@ -64834,7 +63011,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 140, + "line": 146, "character": 16 } ], @@ -64848,9 +63025,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 139 - ] + "children": [139] } ] } @@ -64865,7 +63040,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 147, "character": 8 } ], @@ -64879,10 +63054,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 137, - 140 - ] + "children": [137, 140] } ] } @@ -64905,7 +63077,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 144, + "line": 150, "character": 8 } ], @@ -64923,13 +63095,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 145, + "line": 151, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -64938,10 +63110,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 142, - 143 - ] + "children": [142, 143] } ] } @@ -64961,31 +63130,18 @@ { "title": "Constructors", "kind": 512, - "children": [ - 93 - ] + "children": [93] }, { "title": "Methods", "kind": 2048, - "children": [ - 169, - 181, - 196, - 213, - 222, - 241, - 157, - 232, - 144, - 131 - ] + "children": [169, 181, 197, 214, 226, 246, 157, 237, 144, 131] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 21, + "line": 27, "character": 21 } ] @@ -64995,9 +63151,7 @@ { "title": "Classes", "kind": 128, - "children": [ - 92 - ] + "children": [92] } ], "sources": [ @@ -65013,11 +63167,7 @@ { "title": "Modules", "kind": 2, - "children": [ - 1, - 2, - 91 - ] + "children": [1, 2, 91] } ] }, @@ -65210,10 +63360,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 8, - 7 - ] + "children": [8, 7] } ] } @@ -65603,10 +63750,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 34, - 30 - ] + "children": [34, 30] } ], "sources": [ @@ -65697,26 +63841,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 15, - 14, - 13 - ] + "children": [15, 14, 13] }, { "title": "Methods", "kind": 2048, - "children": [ - 23, - 20 - ] + "children": [23, 20] } ], "sources": [ @@ -65831,16 +63966,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 36 - ] + "children": [36] }, { "title": "Properties", "kind": 1024, - "children": [ - 41 - ] + "children": [41] } ], "sources": [ @@ -65962,16 +64093,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 43 - ] + "children": [43] }, { "title": "Properties", "kind": 1024, - "children": [ - 46 - ] + "children": [46] } ], "sources": [ @@ -66075,16 +64202,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 48 - ] + "children": [48] }, { "title": "Properties", "kind": 1024, - "children": [ - 51 - ] + "children": [51] } ], "sources": [ @@ -66188,16 +64311,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 53 - ] + "children": [53] }, { "title": "Properties", "kind": 1024, - "children": [ - 56 - ] + "children": [56] } ], "sources": [ @@ -66383,10 +64502,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 34, - 30 - ] + "children": [34, 30] } ], "sources": [ @@ -66423,10 +64539,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } } ], @@ -66434,21 +64547,12 @@ { "title": "Classes", "kind": 128, - "children": [ - 1, - 35, - 42, - 47, - 52 - ] + "children": [1, 35, 42, 47, 52] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 28, - 57 - ] + "children": [28, 57] } ], "sources": [ diff --git a/spec/enrichments/tsdoc_v2/functions_dereferenced.json b/spec/enrichments/tsdoc_v2/functions_dereferenced.json index 7f6bc89331e..65eb2310216 100644 --- a/spec/enrichments/tsdoc_v2/functions_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/functions_dereferenced.json @@ -187,10 +187,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 8, - 7 - ] + "children": [8, 7] } ] } @@ -580,10 +577,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 34, - 30 - ] + "children": [34, 30] } ], "sources": [ @@ -674,26 +668,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 15, - 14, - 13 - ] + "children": [15, 14, 13] }, { "title": "Methods", "kind": 2048, - "children": [ - 23, - 20 - ] + "children": [23, 20] } ], "sources": [ @@ -808,16 +793,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 36 - ] + "children": [36] }, { "title": "Properties", "kind": 1024, - "children": [ - 41 - ] + "children": [41] } ], "sources": [ @@ -939,16 +920,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 43 - ] + "children": [43] }, { "title": "Properties", "kind": 1024, - "children": [ - 46 - ] + "children": [46] } ], "sources": [ @@ -1052,16 +1029,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 48 - ] + "children": [48] }, { "title": "Properties", "kind": 1024, - "children": [ - 51 - ] + "children": [51] } ], "sources": [ @@ -1165,16 +1138,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 53 - ] + "children": [53] }, { "title": "Properties", "kind": 1024, - "children": [ - 56 - ] + "children": [56] } ], "sources": [ @@ -1360,10 +1329,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 34, - 30 - ] + "children": [34, 30] } ], "sources": [ @@ -1400,10 +1366,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } } ], @@ -1411,21 +1374,12 @@ { "title": "Classes", "kind": 128, - "children": [ - 1, - 35, - 42, - 47, - 52 - ] + "children": [1, 35, 42, 47, 52] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 28, - 57 - ] + "children": [28, 57] } ], "sources": [ @@ -1435,4 +1389,4 @@ "character": 0 } ] -} \ No newline at end of file +} diff --git a/spec/enrichments/tsdoc_v2/gotrue.json b/spec/enrichments/tsdoc_v2/gotrue.json index 5d2327fea03..6cf1e94f730 100644 --- a/spec/enrichments/tsdoc_v2/gotrue.json +++ b/spec/enrichments/tsdoc_v2/gotrue.json @@ -1,14655 +1,14056 @@ { - "id": 0, - "name": "@supabase/gotrue-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 732, - "name": "AuthApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 733, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 734, - "name": "new AuthApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 735, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 736, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 732, - "name": "AuthApiError" - }, - "overwrites": { - "type": "reference", - "id": 729, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 728, - "name": "AuthError.constructor" - } - }, - { - "id": 737, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 738, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 739, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 740, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 742, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 741, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 743, - "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": [ - 742, - 741, - 743 - ] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 733 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 737 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 738 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 727, - "name": "AuthError" - } - ] - }, - { - "id": 727, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 728, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 729, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 730, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 728 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 732, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 745, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - } - ] - }, - { - "id": 792, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 793, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 78, - "character": 2 - } - ], - "signatures": [ - { - "id": 794, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 795, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 796, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 797, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 799, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 78, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 798, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 78, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 799, - 798 - ] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 792, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 754, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 753, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 800, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 801, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 803, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 802, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 803, - 802 - ] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 814, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 758, - "name": "CustomAuthError.name" - } - }, - { - "id": 815, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 759, - "name": "CustomAuthError.status" - } - }, - { - "id": 804, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 805, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 806, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 810, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 88, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 811, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 813, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 812, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 77, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 813, - 812 - ] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 808, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 86, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 807, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 809, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 87, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 810, - 808, - 807, - 809 - ] - } - ] - } - }, - "overwrites": { - "type": "reference", - "id": 761, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "id": 760, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 793 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 800, - 814, - 815 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 804 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 76, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - } - ] - }, - { - "id": 779, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 780, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 71, - "character": 2 - } - ], - "signatures": [ - { - "id": 781, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 782, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 779, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 754, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 753, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 783, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 758, - "name": "CustomAuthError.name" - } - }, - { - "id": 784, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 759, - "name": "CustomAuthError.status" - } - }, - { - "id": 785, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 786, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 787, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 789, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 788, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 790, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 789, - 788, - 790 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 761, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 760, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 780 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 783, - 784 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 785 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 70, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - } - ] - }, - { - "id": 817, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 818, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 94, - "character": 2 - } - ], - "signatures": [ - { - "id": 819, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 820, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 821, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 817, - "name": "AuthRetryableFetchError" - }, - "overwrites": { - "type": "reference", - "id": 754, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 753, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 822, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 758, - "name": "CustomAuthError.name" - } - }, - { - "id": 823, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 759, - "name": "CustomAuthError.status" - } - }, - { - "id": 824, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 825, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 826, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 828, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 827, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 829, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 828, - 827, - 829 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 761, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 760, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 818 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 822, - 823 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 824 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 93, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - } - ] - }, - { - "id": 767, - "name": "AuthSessionMissingError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 768, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 65, - "character": 2 - } - ], - "signatures": [ - { - "id": 769, - "name": "new AuthSessionMissingError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "type": { - "type": "reference", - "id": 767, - "name": "AuthSessionMissingError" - }, - "overwrites": { - "type": "reference", - "id": 754, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 753, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 770, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 758, - "name": "CustomAuthError.name" - } - }, - { - "id": 771, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 759, - "name": "CustomAuthError.status" - } - }, - { - "id": 772, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 773, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 774, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 776, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 775, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 777, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 776, - 775, - 777 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 761, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 760, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 768 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 770, - 771 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 772 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 64, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - } - ] - }, - { - "id": 745, - "name": "AuthUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 746, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 39, - "character": 2 - } - ], - "signatures": [ - { - "id": 747, - "name": "new AuthUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 748, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 745, - "name": "AuthUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 729, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 728, - "name": "AuthError.constructor" - } - }, - { - "id": 750, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 746 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 750 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 36, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 727, - "name": "AuthError" - } - ] - }, - { - "id": 752, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 753, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 754, - "name": "new CustomAuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 755, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 756, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 752, - "name": "CustomAuthError" - }, - "overwrites": { - "type": "reference", - "id": 729, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 728, - "name": "AuthError.constructor" - } - }, - { - "id": 758, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "name": "AuthError.name" - } - }, - { - "id": 759, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 760, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 761, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 762, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 764, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 763, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 765, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 764, - 763, - 765 - ] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 753 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 758, - 759 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 760 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 46, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 727, - "name": "AuthError" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 767, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "id": 779, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "id": 792, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "id": 817, - "name": "AuthRetryableFetchError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 28, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new GoTrueAdminApi", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 11, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 13, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 14, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 15, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 9, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 10, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 6, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 11, - 7, - 6 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 16, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Contains all MFA administration methods." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 699, - "name": "GoTrueAdminMFAApi" - } - }, - { - "id": 43, - "name": "createUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 139, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "name": "createUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." - }, - "parameters": [ - { - "id": 45, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 411, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 66, - "name": "deleteUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 234, - "character": 8 - } - ], - "signatures": [ - { - "id": 67, - "name": "deleteUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Delete a user. Requires a `service_role` key." - }, - "parameters": [ - { - "id": 68, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 40, - "name": "generateLink", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 105, - "character": 8 - } - ], - "signatures": [ - { - "id": 41, - "name": "generateLink", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider." - }, - "parameters": [ - { - "id": 42, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 543, - "name": "GenerateLinkParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 544, - "name": "GenerateLinkResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 59, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 189, - "character": 8 - } - ], - "signatures": [ - { - "id": 60, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 61, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 33, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 75, - "character": 8 - } - ], - "signatures": [ - { - "id": 34, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 35, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 39, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 79, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 38, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 78, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 39, - 38 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 46, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 8 - } - ], - "signatures": [ - { - "id": 47, - "name": "listUsers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." - }, - "parameters": [ - { - "id": 48, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object which supports `page` and `per_page` as numbers, to alter the paginated results.\n" - }, - "type": { - "type": "reference", - "id": 717, - "name": "PageParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 15 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 51, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 52, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 23 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 384, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 52 - ] - } - ] - } - } - }, - { - "id": 53, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 40 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 50, - 53 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 54, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 55, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 58 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 57, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 66 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 57 - ] - } - ] - } - } - }, - { - "id": 58, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 163, - "character": 79 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 55, - 58 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 27, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 8 - } - ], - "signatures": [ - { - "id": 28, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 29, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 30, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 31, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 40 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 32, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 52 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 727, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 31, - 32 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 62, - "name": "updateUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 211, - "character": 8 - } - ], - "signatures": [ - { - "id": 63, - "name": "updateUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the user data." - }, - "parameters": [ - { - "id": 64, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 65, - "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": 411, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 2 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 16 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 43, - 66, - 40, - 59, - 33, - 46, - 27, - 62 - ] - } - ], - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 18, - "character": 21 - } - ] - }, - { - "id": 75, - "name": "GoTrueClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 76, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 127, - "character": 2 - } - ], - "signatures": [ - { - "id": 77, - "name": "new GoTrueClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "parameters": [ - { - "id": 78, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 288, - "name": "GoTrueClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 75, - "name": "default" - } - } - ] - }, - { - "id": 79, - "name": "admin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 80, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the MFA methods." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 654, - "name": "GoTrueMFAApi" - } - }, - { - "id": 124, - "name": "getSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 487, - "character": 8 - } - ], - "signatures": [ - { - "id": 125, - "name": "getSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 126, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 127, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 129, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 490, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 347, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 129 - ] - } - ] - } - } - }, - { - "id": 130, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 492, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 127, - 130 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 132, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 495, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 134, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 496, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 134 - ] - } - ] - } - } - }, - { - "id": 135, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 498, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 132, - 135 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 137, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 501, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 502, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 139 - ] - } - ] - } - } - }, - { - "id": 140, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 504, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 137, - 140 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 141, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 550, - "character": 8 - } - ], - "signatures": [ - { - "id": 142, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details if there is an existing session." - }, - "parameters": [ - { - "id": 143, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 102, - "name": "initialize", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 162, - "character": 2 - } - ], - "signatures": [ - { - "id": 103, - "name": "initialize", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 707, - "name": "InitializeResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 185, - "name": "onAuthStateChange", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 834, - "character": 2 - } - ], - "signatures": [ - { - "id": 186, - "name": "onAuthStateChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Receive a notification every time an auth event happens." - }, - "parameters": [ - { - "id": 187, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 188, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 189, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 190, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 287, - "name": "AuthChangeEvent" - } - }, - { - "id": 191, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 347, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 835, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 835, - "character": 12 - } - ], - "type": { - "type": "reference", - "id": 421, - "name": "Subscription" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 195 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 193 - ] - } - ] - } - } - } - ] - }, - { - "id": 160, - "name": "refreshSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 689, - "character": 8 - } - ], - "signatures": [ - { - "id": 161, - "name": "refreshSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - }, - "parameters": [ - { - "id": 162, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 163, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 164, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 689, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 164 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 196, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 857, - "character": 8 - } - ], - "signatures": [ - { - "id": 197, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a password reset request to an email address." - }, - "parameters": [ - { - "id": 198, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 199, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 200, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 202, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 861, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 201, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL to send the user to after they click the password reset link." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 860, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 202, - 201 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 204, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 865, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 206, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 866, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 204, - 206 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 868, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 209, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 868, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 208, - 209 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 154, - "name": "setSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 626, - "character": 8 - } - ], - "signatures": [ - { - "id": 155, - "name": "setSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - }, - "parameters": [ - { - "id": 156, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The current session that minimally contains an access token and refresh token.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 158, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 159, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 158, - 159 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 112, - "name": "signInWithOAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 340, - "character": 8 - } - ], - "signatures": [ - { - "id": 113, - "name": "signInWithOAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider." - }, - "parameters": [ - { - "id": 114, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 478, - "name": "SignInWithOAuthCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 314, - "name": "OAuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 115, - "name": "signInWithOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 355, - "character": 8 - } - ], - "signatures": [ - { - "id": 116, - "name": "signInWithOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins." - }, - "parameters": [ - { - "id": 117, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 462, - "name": "SignInWithPasswordlessCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 109, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 288, - "character": 8 - } - ], - "signatures": [ - { - "id": 110, - "name": "signInWithPassword", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user with an email and password or phone and password." - }, - "parameters": [ - { - "id": 111, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 447, - "name": "SignInWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 121, - "name": "signInWithSSO", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 458, - "character": 8 - } - ], - "signatures": [ - { - "id": 122, - "name": "signInWithSSO", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", - "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n\nThis API is experimental and availability is conditional on correct\nsettings on the Auth service.\n", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 123, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 508, - "name": "SignInWithSSO" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 327, - "name": "SSOResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 181, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 809, - "character": 8 - } - ], - "signatures": [ - { - "id": 182, - "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)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 184, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 809, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 727, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 184 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 106, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 225, - "character": 8 - } - ], - "signatures": [ - { - "id": 107, - "name": "signUp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 108, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 431, - "name": "SignUpWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 144, - "name": "updateUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 579, - "character": 8 - } - ], - "signatures": [ - { - "id": 145, - "name": "updateUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data, if there is a logged in user." - }, - "parameters": [ - { - "id": 146, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 406, - "name": "UserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 336, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 118, - "name": "verifyOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 399, - "character": 8 - } - ], - "signatures": [ - { - "id": 119, - "name": "verifyOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 120, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 489, - "name": "VerifyOtpParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 301, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 76 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 79, - 80 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 124, - 141, - 102, - 185, - 160, - 196, - 154, - 112, - 115, - 109, - 121, - 181, - 106, - 144, - 118 - ] - } - ], - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 82, - "character": 21 - } - ] - }, - { - "id": 356, - "name": "AMREntry", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "An authentication methord reference (AMR) entry.", - "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" - } - ] - }, - "children": [ - { - "id": 357, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Authentication method name." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 358, - "name": "timestamp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 158, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 357, - 358 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 150, - "character": 17 - } - ] - }, - { - "id": 411, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 413, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 280, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 416, - "name": "ban_duration", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 306, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 420, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 255, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - }, - "inheritedFrom": { - "type": "reference", - "id": 410, - "name": "UserAttributes.data" - } - }, - { - "id": 417, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 237, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 407, - "name": "UserAttributes.email" - } - }, - { - "id": 414, - "name": "email_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 287, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 419, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 409, - "name": "UserAttributes.password" - } - }, - { - "id": 418, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 242, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 408, - "name": "UserAttributes.phone" - } - }, - { - "id": 415, - "name": "phone_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 294, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 412, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 270, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 258, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 406, - "name": "UserAttributes" - } - ] - }, - { - "id": 370, - "name": "Factor", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "A MFA factor.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#listFactors}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAAdminApi#listFactors}\n" - } - ] - }, - "children": [ - { - "id": 375, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 196, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 373, - "name": "factor_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 191, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "friendly_name", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 185, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 182, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 374, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Factor's status." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 194, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "verified" - }, - { - "type": "literal", - "value": "unverified" - } - ] - } - }, - { - "id": 376, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 375, - 373, - 372, - 371, - 374, - 376 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 180, - "character": 17 - } - ] - }, - { - "id": 540, - "name": "GenerateLinkOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 541, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 540, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 542, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL which will be appended to the email link generated." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 542, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 541, - 542 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 534, - "character": 17 - } - ] - }, - { - "id": 699, - "name": "GoTrueAdminMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "children": [ - { - "id": 703, - "name": "deleteFactor", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 704, - "name": "deleteFactor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" - }, - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 705, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 683, - "name": "AuthMFAAdminDeleteFactorParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 674, - "name": "AuthMFAAdminDeleteFactorResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 700, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 701, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all factors associated to a user." - }, - "parameters": [ - { - "id": 702, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 696, - "name": "AuthMFAAdminListFactorsParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 687, - "name": "AuthMFAAdminListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [ - 703, - 700 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 876, - "character": 17 - } - ] - }, - { - "id": 654, - "name": "GoTrueMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication API." - }, - "children": [ - { - "id": 658, - "name": "challenge", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 659, - "name": "challenge", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - }, - "parameters": [ - { - "id": 660, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 578, - "name": "MFAChallengeParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 622, - "name": "AuthMFAChallengeResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 667, - "name": "challengeAndVerify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 668, - "name": "challengeAndVerify", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - }, - "parameters": [ - { - "id": 669, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 581, - "name": "MFAChallengeAndVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 585, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 655, - "name": "enroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 656, - "name": "enroll", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", - "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" - }, - "parameters": [ - { - "id": 657, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 565, - "name": "MFAEnrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 598, - "name": "AuthMFAEnrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 672, - "name": "getAuthenticatorAssuranceLevel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 673, - "name": "getAuthenticatorAssuranceLevel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 643, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 670, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 671, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the list of MFA factors enabled for this user. For most use cases\nyou should consider using {@link\nGoTrueMFAApi#getAuthenticatorAssuranceLevel}. This uses a cached version\nof the factors and avoids incurring a network call. If you need to update\nthis list, call {@link GoTrueClient#getUser} first.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, - { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n\n" - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 632, - "name": "AuthMFAListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 664, - "name": "unenroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 665, - "name": "unenroll", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." - }, - "parameters": [ - { - "id": 666, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 570, - "name": "MFAUnenrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 613, - "name": "AuthMFAUnenrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 661, - "name": "verify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 662, - "name": "verify", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - }, - "parameters": [ - { - "id": 663, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 573, - "name": "MFAVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 585, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [ - 658, - 667, - 655, - 672, - 670, - 664, - 661 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 759, - "character": 17 - } - ] - }, - { - "id": 347, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 350, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, - "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": 137, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 352, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 133, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 349, - "name": "provider_refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 348, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 351, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "A one-time used refresh token that never expires." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 129, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 354, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 138, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 355, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 384, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 350, - 353, - 352, - 349, - 348, - 351, - 354, - 355 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 17 - } - ] - }, - { - "id": 421, - "name": "Subscription", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 422, - "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": 313, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "callback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 317, - "character": 2 - } - ], - "signatures": [ - { - "id": 424, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ - { - "id": 425, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 287, - "name": "AuthChangeEvent" - } - }, - { - "id": 426, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 347, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 427, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 321, - "character": 2 - } - ], - "signatures": [ - { - "id": 428, - "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": [ - 422 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 423, - 427 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 309, - "character": 17 - } - ] - }, - { - "id": 429, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 430, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 430 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 17 - } - ] - }, - { - "id": 384, - "name": "User", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 394, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 386, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 211, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 377, - "name": "UserAppMetadata" - } - }, - { - "id": 388, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 389, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 214, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 398, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 223, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 395, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 220, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 391, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 216, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 399, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 224, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 230, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 370, - "name": "Factor" - } - } - }, - { - "id": 385, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 404, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 229, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 359, - "name": "UserIdentity" - } - } - }, - { - "id": 393, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 218, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 401, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 226, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 392, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 217, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 396, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 221, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 390, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 215, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 403, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 228, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 387, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 212, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 381, - "name": "UserMetadata" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 394, - 386, - 388, - 389, - 398, - 397, - 395, - 391, - 399, - 405, - 385, - 404, - 393, - 401, - 392, - 396, - 400, - 390, - 402, - 403, - 387 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 17 - } - ] - }, - { - "id": 377, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 378, - "name": "provider", - "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": [ - 378 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 17 - } - ], - "indexSignature": { - "id": 379, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 380, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 406, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 410, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 255, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 407, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 237, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 242, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 410, - 407, - 409, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 233, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 411, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 359, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 367, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 168, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 162, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 362, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 164, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 364, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 365, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 368, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 169, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 366, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 167, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 369, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 170, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 163, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 367, - 360, - 362, - 368, - 366, - 369, - 361 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 161, - "character": 17 - } - ] - }, - { - "id": 381, - "name": "UserMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 205, - "character": 17 - } - ], - "indexSignature": { - "id": 382, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 383, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 498, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 499, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 468, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 502, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 503, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 505, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 477, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 504, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 475, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 505, - 504 - ] - } - ] - } - } - }, - { - "id": 500, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 470, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 501, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 472, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 507, - "name": "EmailOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 466, - "character": 17 - } - ] - }, - { - "id": 490, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 494, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 454, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 495, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 497, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 463, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 496, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 456, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 497, - 496 - ] - } - ] - } - } - }, - { - "id": 491, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 449, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 492, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 451, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 493, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 453, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 506, - "name": "MobileOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 447, - "character": 17 - } - ] - }, - { - "id": 287, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 25, - "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" - }, - { - "type": "reference", - "id": 286, - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "id": 286, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 683, - "name": "AuthMFAAdminDeleteFactorParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 842, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 684, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 685, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 844, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 686, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user whose factor is being deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 847, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 685, - 686 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 842, - "character": 45 - } - ] - } - } - }, - { - "id": 674, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 829, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 676, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 831, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 678, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 833, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 678 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 831, - "character": 12 - } - ] - } - } - }, - { - "id": 679, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 835, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 676, - 679 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 830, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 680, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 681, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 837, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 682, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 837, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 681, - 682 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 837, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 696, - "name": "AuthMFAAdminListFactorsParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 866, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 697, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 698, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 868, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 698 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 866, - "character": 44 - } - ] - } - } - }, - { - "id": 687, - "name": "AuthMFAAdminListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 853, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 688, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 689, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 855, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 690, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 691, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All factors attached to the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 370, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 691 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 855, - "character": 12 - } - ] - } - } - }, - { - "id": 692, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 859, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 689, - 692 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 854, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 693, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 694, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 695, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 694, - 695 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 622, - "name": "AuthMFAChallengeResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 702, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 623, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 624, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 704, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 625, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 627, - "name": "expires_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 709, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 626, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the newly created challenge." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 706, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 627, - 626 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 704, - "character": 12 - } - ] - } - } - }, - { - "id": 628, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 711, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 624, - 628 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 703, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 629, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 630, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 713, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 631, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 713, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 630, - 631 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 713, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 598, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 659, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 599, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 600, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 661, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 601, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 602, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 663, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 604, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 669, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 605, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 606, - "name": "qr_code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 673, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 607, - "name": "secret", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 678, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 608, - "name": "uri", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 682, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 606, - 607, - 608 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 669, - "character": 14 - } - ] - } - } - }, - { - "id": 603, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 666, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 602, - 604, - 603 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 661, - "character": 12 - } - ] - } - } - }, - { - "id": 609, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 685, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 600, - 609 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 660, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 611, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 688, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 612, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 689, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 611, - 612 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 687, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 643, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 644, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 645, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 732, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 646, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 649, - "name": "currentAuthenticationMethods", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 749, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 356, - "name": "AMREntry" - } - } - }, - { - "id": 647, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 734, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 642, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 648, - "name": "nextLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 742, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 642, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 649, - 647, - 648 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 732, - "character": 12 - } - ] - } - } - }, - { - "id": 650, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 751, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 645, - 650 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 731, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 651, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 652, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 653, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 652, - 653 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 632, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 715, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 633, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 634, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 717, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 635, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 636, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 719, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 370, - "name": "Factor" - } - } - }, - { - "id": 637, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 722, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 370, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 636, - 637 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 717, - "character": 12 - } - ] - } - } - }, - { - "id": 638, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 724, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 634, - 638 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 716, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 639, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 640, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 641, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 640, - 641 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 726, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 613, - "name": "AuthMFAUnenrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 692, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 614, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 615, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 694, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 616, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 617, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 617 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 694, - "character": 12 - } - ] - } - } - }, - { - "id": 618, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 698, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 615, - 618 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 693, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 619, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 620, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 700, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 621, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 700, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 620, - 621 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 700, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 585, - "name": "AuthMFAVerifyResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 634, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 586, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 587, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 636, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 588, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 589, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "New access token (JWT) after successful verification." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 638, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 591, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 644, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 592, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 647, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 590, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of token, typically `Bearer`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 641, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 593, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Updated user profile." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 650, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 384, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 589, - 591, - 592, - 590, - 593 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 636, - "character": 12 - } - ] - } - } - }, - { - "id": 594, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 652, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 587, - 594 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 635, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 596, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 655, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 597, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 656, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 596, - 597 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 654, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 301, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 303, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 304, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 306, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 347, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 305, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 384, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 306, - 305 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 55, - "character": 12 - } - ] - } - } - }, - { - "id": 307, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 303, - 307 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 54, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 308, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 309, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 312, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 311, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 312, - 311 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 12 - } - ] - } - } - }, - { - "id": 313, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 66, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 309, - 313 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 642, - "name": "AuthenticatorAssuranceLevels", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 728, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - } - ] - } - }, - { - "id": 710, - "name": "CallRefreshTokenResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 907, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 711, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 713, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 910, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 712, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 909, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 347, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 713, - 712 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 908, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 714, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 716, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 914, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - }, - { - "id": 715, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 913, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 716, - 715 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 912, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 507, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 482, - "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": 534, - "name": "GenerateEmailChangeLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 523, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 535, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 537, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 526, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "newEmail", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 530, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 536, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 523, - "character": 44 - } - ] - } - } - }, - { - "id": 524, - "name": "GenerateInviteOrMagiclinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 527, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 512, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 528, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 513, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 526, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 510, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 527, - 528, - 526 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, - "character": 46 - } - ] - } - } - }, - { - "id": 543, - "name": "GenerateLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 545, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 518, - "name": "GenerateSignupLinkParams" - }, - { - "type": "reference", - "id": 524, - "name": "GenerateInviteOrMagiclinkParams" - }, - { - "type": "reference", - "id": 529, - "name": "GenerateRecoveryLinkParams" - }, - { - "type": "reference", - "id": 534, - "name": "GenerateEmailChangeLinkParams" - } - ] - } - }, - { - "id": 557, - "name": "GenerateLinkProperties", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "The properties related to the email link generated" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 568, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 558, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 559, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 573, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 560, - "name": "email_otp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 578, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 561, - "name": "hashed_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The hashed token appended to the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 582, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 562, - "name": "redirect_to", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The URL appended to the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 584, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 563, - "name": "verification_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The verification type that the email link is associated to." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 586, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 564, - "name": "GenerateLinkType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 559, - 560, - 561, - 562, - 563 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 568, - "character": 37 - } - ] - } - } - }, - { - "id": 544, - "name": "GenerateLinkResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 551, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 545, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 546, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 553, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 547, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 548, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 554, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 557, - "name": "GenerateLinkProperties" - } - }, - { - "id": 549, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 555, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 384, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 548, - 549 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 553, - "character": 12 - } - ] - } - } - }, - { - "id": 550, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 557, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 546, - 550 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 552, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 551, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 552, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 560, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 553, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 554, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 561, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 555, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 562, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 554, - 555 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 560, - "character": 12 - } - ] - } - } - }, - { - "id": 556, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 564, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 552, - 556 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 559, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 564, - "name": "GenerateLinkType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 589, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 529, - "name": "GenerateRecoveryLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 516, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 530, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 532, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 519, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 531, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 517, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 532, - 533, - 531 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 516, - "character": 41 - } - ] - } - } - }, - { - "id": 518, - "name": "GenerateSignupLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 502, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 519, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 521, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 504, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 523, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 506, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 540, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 522, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 505, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 520, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 503, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 502, - "character": 39 - } - ] - } - } - }, - { - "id": 288, - "name": "GoTrueClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 297, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 296, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 300, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 291, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 292, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 12 - } - ], - "indexSignature": { - "id": 293, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 294, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 298, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 299, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 706, - "name": "SupportedStorage" - } - }, - { - "id": 295, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 290, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 297, - 296, - 300, - 291, - 298, - 299, - 295, - 290 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 34 - } - ] - } - } - }, - { - "id": 707, - "name": "InitializeResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 708, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 709, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 727, - "name": "AuthError" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 709 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 31 - } - ] - } - } - }, - { - "id": 581, - "name": "MFAChallengeAndVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 627, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 582, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 584, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 631, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 583, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 629, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 584, - 583 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 627, - "character": 42 - } - ] - } - } - }, - { - "id": 578, - "name": "MFAChallengeParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 622, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 580, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 624, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 580 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 622, - "character": 33 - } - ] - } - } - }, - { - "id": 565, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 566, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 567, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of factor being enrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 599, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 569, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Human readable name assigned to the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 603, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 568, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Domain which the user is enrolled with." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 601, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 567, - 569, - 568 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 30 - } - ] - } - } - }, - { - "id": 570, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 606, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 571, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 572, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 608, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 572 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 606, - "character": 32 - } - ] - } - } - }, - { - "id": 573, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 611, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 574, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 576, - "name": "challengeId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 616, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 577, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 619, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 575, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 576, - 577, - 575 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 611, - "character": 30 - } - ] - } - } - }, - { - "id": 506, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 481, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - }, - { - "id": 314, - "name": "OAuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 315, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 316, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 317, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 318, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 285, - "name": "Provider" - } - }, - { - "id": 319, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 318, - 319 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 12 - } - ] - } - } - }, - { - "id": 320, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 75, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 316, - 320 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 70, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 323, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 324, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 285, - "name": "Provider" - } - }, - { - "id": 325, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 324, - 325 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 12 - } - ] - } - } - }, - { - "id": 326, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 322, - 326 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 717, - "name": "PageParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 917, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 719, - "name": "page", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The page number" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 919, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 720, - "name": "perPage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Number of items returned per page" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 921, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 719, - 720 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 917, - "character": 25 - } - ] - } - } - }, - { - "id": 285, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "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": 327, - "name": "SSOResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 329, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 330, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 331, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "URL to take the user to (in a browser) to complete SSO." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 331 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 12 - } - ] - } - } - }, - { - "id": 332, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 329, - 332 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 86, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 334, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 335, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 334, - 335 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 478, - "name": "SignInWithOAuthCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 433, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 479, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 481, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 436, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 485, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object of query params" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 442, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 486, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 442, - "character": 18 - } - ], - "indexSignature": { - "id": 487, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 488, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 483, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 438, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 484, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 440, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 485, - 483, - 484 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 436, - "character": 12 - } - ] - } - } - }, - { - "id": 480, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 435, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 285, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 481, - 480 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 433, - "character": 41 - } - ] - } - } - }, - { - "id": 447, - "name": "SignInWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 363, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 448, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 449, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 366, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 369, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 454, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 377, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 453, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 375, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 454, - 453 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 369, - "character": 16 - } - ] - } - } - }, - { - "id": 450, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 368, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 449, - 451, - 450 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 364, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 458, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 385, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 461, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 393, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 460, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 391, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 461, - 460 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 385, - "character": 16 - } - ] - } - } - }, - { - "id": 457, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 384, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 456, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 382, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 458, - 457, - 456 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 380, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 462, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 397, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 464, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 400, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 465, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 466, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 470, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 413, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 469, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 411, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 467, - "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": 403, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 405, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 470, - 469, - 467, - 468 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 464, - 465 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 398, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 471, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 473, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 419, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 477, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 429, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 476, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 427, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 475, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 421, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 477, - 476, - 475 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 419, - "character": 16 - } - ] - } - } - }, - { - "id": 472, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 418, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 473, - 472 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 416, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 508, - "name": "SignInWithSSO", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 484, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 509, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 510, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 485, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 513, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 489, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 512, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 487, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 513, - 512 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 485, - "character": 12 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 510 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 484, - "character": 28 - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 514, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 515, - "name": "providerId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 494, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 515 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 492, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 517, - "name": "domain", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 498, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 517 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 496, - "character": 4 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 431, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 433, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 439, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 344, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 438, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 437, - "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": 336, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 439, - 438, - 437 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 16 - } - ] - } - } - }, - { - "id": 434, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 433, - 435, - 434 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 443, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 352, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 444, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 446, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 360, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 358, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 446, - 445 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 352, - "character": 16 - } - ] - } - } - }, - { - "id": 442, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 351, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 349, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 443, - 442, - 441 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 347, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 706, - "name": "SupportedStorage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "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": 336, - "name": "UserResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 98, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 338, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 339, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 340, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 384, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 340 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 - } - ] - } - } - }, - { - "id": 341, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 103, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 338, - 341 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 342, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 343, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 344, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 345, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 345 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 12 - } - ] - } - } - }, - { - "id": 346, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 343, - 346 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 105, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 489, - "name": "VerifyOtpParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 446, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 490, - "name": "VerifyMobileOtpParams" - }, - { - "type": "reference", - "id": 498, - "name": "VerifyEmailOtpParams" - } - ] - } - }, - { - "id": 724, - "name": "isAuthApiError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 16 - } - ], - "signatures": [ - { - "id": 725, - "name": "isAuthApiError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 726, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 732, - "name": "AuthApiError" - } - } - } - ] - }, - { - "id": 721, - "name": "isAuthError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } - ], - "signatures": [ - { - "id": 722, - "name": "isAuthError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 723, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 727, - "name": "AuthError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 732, - 727, - 792, - 779, - 817, - 767, - 745, - 752, - 1, - 75 - ] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [ - 356, - 411, - 370, - 540, - 699, - 654, - 347, - 421, - 429, - 384, - 377, - 406, - 359, - 381, - 498, - 490 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 287, - 286, - 683, - 674, - 696, - 687, - 622, - 598, - 643, - 632, - 613, - 585, - 301, - 642, - 710, - 507, - 534, - 524, - 543, - 557, - 544, - 564, - 529, - 518, - 288, - 707, - 581, - 578, - 565, - 570, - 573, - 506, - 314, - 717, - 285, - 327, - 478, - 447, - 462, - 508, - 431, - 706, - 336, - 489 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [ - 724, - 721 - ] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] -} \ No newline at end of file + "id": 0, + "name": "@supabase/gotrue-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 732, + "name": "AuthApiError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 733, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 17, + "character": 2 + } + ], + "signatures": [ + { + "id": 734, + "name": "new AuthApiError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 735, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 736, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 732, + "name": "AuthApiError" + }, + "overwrites": { + "type": "reference", + "id": 729, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 728, + "name": "AuthError.constructor" + } + }, + { + "id": 737, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 15, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 738, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 23, + "character": 2 + } + ], + "signatures": [ + { + "id": 739, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 740, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 742, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 741, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 743, + "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": [742, 741, 743] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [733] + }, + { + "title": "Properties", + "kind": 1024, + "children": [737] + }, + { + "title": "Methods", + "kind": 2048, + "children": [738] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 727, + "name": "AuthError" + } + ] + }, + { + "id": 727, + "name": "AuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 728, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 2 + } + ], + "signatures": [ + { + "id": 729, + "name": "new AuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 730, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [728] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 1, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 732, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 745, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + } + ] + }, + { + "id": 792, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 793, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 78, + "character": 2 + } + ], + "signatures": [ + { + "id": 794, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 795, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 796, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 797, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 799, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 78, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 798, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 78, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [799, 798] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 792, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 754, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 753, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 800, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 801, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 803, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 802, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [803, 802] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 814, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 758, + "name": "CustomAuthError.name" + } + }, + { + "id": 815, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 759, + "name": "CustomAuthError.status" + } + }, + { + "id": 804, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 805, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 806, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 810, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 88, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 811, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 813, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 812, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 77, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [813, 812] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 808, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 86, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 807, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 85, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 809, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 87, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [810, 808, 807, 809] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 761, + "name": "CustomAuthError.toJSON" + } + } + ], + "overwrites": { + "type": "reference", + "id": 760, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [793] + }, + { + "title": "Properties", + "kind": 1024, + "children": [800, 814, 815] + }, + { + "title": "Methods", + "kind": 2048, + "children": [804] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 76, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + } + ] + }, + { + "id": 779, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 780, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 71, + "character": 2 + } + ], + "signatures": [ + { + "id": 781, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 782, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 779, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 754, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 753, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 783, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 758, + "name": "CustomAuthError.name" + } + }, + { + "id": 784, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 759, + "name": "CustomAuthError.status" + } + }, + { + "id": 785, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 786, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 787, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 789, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 58, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 788, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 790, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [789, 788, 790] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 761, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 760, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [780] + }, + { + "title": "Properties", + "kind": 1024, + "children": [783, 784] + }, + { + "title": "Methods", + "kind": 2048, + "children": [785] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 70, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + } + ] + }, + { + "id": 817, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 818, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 94, + "character": 2 + } + ], + "signatures": [ + { + "id": 819, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 820, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 817, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 754, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 753, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 822, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 758, + "name": "CustomAuthError.name" + } + }, + { + "id": 823, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 759, + "name": "CustomAuthError.status" + } + }, + { + "id": 824, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 825, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 826, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 828, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 58, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 827, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 829, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [828, 827, 829] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 761, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 760, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [818] + }, + { + "title": "Properties", + "kind": 1024, + "children": [822, 823] + }, + { + "title": "Methods", + "kind": 2048, + "children": [824] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 93, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + } + ] + }, + { + "id": 767, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 768, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 65, + "character": 2 + } + ], + "signatures": [ + { + "id": 769, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 767, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 754, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 753, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 770, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 758, + "name": "CustomAuthError.name" + } + }, + { + "id": 771, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 759, + "name": "CustomAuthError.status" + } + }, + { + "id": 772, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 773, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 776, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 58, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 775, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 777, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [776, 775, 777] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 761, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 760, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [768] + }, + { + "title": "Properties", + "kind": 1024, + "children": [770, 771] + }, + { + "title": "Methods", + "kind": 2048, + "children": [772] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 64, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + } + ] + }, + { + "id": 745, + "name": "AuthUnknownError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 746, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 39, + "character": 2 + } + ], + "signatures": [ + { + "id": 747, + "name": "new AuthUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 748, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 749, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 745, + "name": "AuthUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 729, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 728, + "name": "AuthError.constructor" + } + }, + { + "id": 750, + "name": "originalError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [746] + }, + { + "title": "Properties", + "kind": 1024, + "children": [750] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 36, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 727, + "name": "AuthError" + } + ] + }, + { + "id": 752, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 753, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 49, + "character": 2 + } + ], + "signatures": [ + { + "id": 754, + "name": "new CustomAuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 755, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 756, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 757, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 752, + "name": "CustomAuthError" + }, + "overwrites": { + "type": "reference", + "id": 729, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 728, + "name": "AuthError.constructor" + } + }, + { + "id": 758, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "name": "AuthError.name" + } + }, + { + "id": 759, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 760, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 761, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 762, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 764, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 58, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 763, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 57, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 765, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 763, 765] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [753] + }, + { + "title": "Properties", + "kind": 1024, + "children": [758, 759] + }, + { + "title": "Methods", + "kind": 2048, + "children": [760] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 46, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 727, + "name": "AuthError" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 767, + "name": "AuthSessionMissingError" + }, + { + "type": "reference", + "id": 779, + "name": "AuthInvalidCredentialsError" + }, + { + "type": "reference", + "id": 792, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 817, + "name": "AuthRetryableFetchError" + } + ] + }, + { + "id": 1, + "name": "GoTrueAdminApi", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 28, + "character": 2 + } + ], + "signatures": [ + { + "id": 3, + "name": "new GoTrueAdminApi", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 4, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 11, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 37, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 13, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 15, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 7, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 34, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 8, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 9, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 10, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 6, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 33, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [11, 7, 6] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + } + ] + }, + { + "id": 16, + "name": "mfa", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Contains all MFA administration methods." + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 699, + "name": "GoTrueAdminMFAApi" + } + }, + { + "id": 43, + "name": "createUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 139, + "character": 8 + } + ], + "signatures": [ + { + "id": 44, + "name": "createUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + }, + "parameters": [ + { + "id": 45, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 411, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 66, + "name": "deleteUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 234, + "character": 8 + } + ], + "signatures": [ + { + "id": 67, + "name": "deleteUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Delete a user. Requires a `service_role` key." + }, + "parameters": [ + { + "id": 68, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 40, + "name": "generateLink", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 105, + "character": 8 + } + ], + "signatures": [ + { + "id": 41, + "name": "generateLink", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Generates email links and OTPs to be sent via a custom email provider." + }, + "parameters": [ + { + "id": 42, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 543, + "name": "GenerateLinkParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 544, + "name": "GenerateLinkResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 59, + "name": "getUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 189, + "character": 8 + } + ], + "signatures": [ + { + "id": 60, + "name": "getUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get user by id." + }, + "parameters": [ + { + "id": 61, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 33, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 75, + "character": 8 + } + ], + "signatures": [ + { + "id": 34, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends an invite link to an email address." + }, + "parameters": [ + { + "id": 35, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 36, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 37, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 39, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional user metadata\n" + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 79, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 38, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 78, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [39, 38] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 46, + "name": "listUsers", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 161, + "character": 8 + } + ], + "signatures": [ + { + "id": 47, + "name": "listUsers", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get a list of users.", + "text": "This function should only be called on a server. Never expose your `service_role` key in the browser." + }, + "parameters": [ + { + "id": 48, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "An object which supports `page` and `per_page` as numbers, to alter the paginated results.\n" + }, + "type": { + "type": "reference", + "id": 717, + "name": "PageParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 49, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 50, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 15 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 51, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 52, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 23 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 384, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [52] + } + ] + } + } + }, + { + "id": 53, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 40 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [50, 53] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 54, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 55, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 58 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 56, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 57, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 66 + } + ], + "type": { + "type": "tuple" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [57] + } + ] + } + } + }, + { + "id": 58, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 163, + "character": 79 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [55, 58] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 27, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 52, + "character": 8 + } + ], + "signatures": [ + { + "id": 28, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Removes a logged-in session." + }, + "parameters": [ + { + "id": 29, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A valid, logged-in JWT.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 30, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 31, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 52, + "character": 40 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 32, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 52, + "character": 52 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 727, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [31, 32] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 62, + "name": "updateUserById", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 211, + "character": 8 + } + ], + "signatures": [ + { + "id": 63, + "name": "updateUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates the user data." + }, + "parameters": [ + { + "id": 64, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 65, + "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": 411, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [2] + }, + { + "title": "Properties", + "kind": 1024, + "children": [16] + }, + { + "title": "Methods", + "kind": 2048, + "children": [43, 66, 40, 59, 33, 46, 27, 62] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 18, + "character": 21 + } + ] + }, + { + "id": 75, + "name": "GoTrueClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 76, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 127, + "character": 2 + } + ], + "signatures": [ + { + "id": 77, + "name": "new GoTrueClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "parameters": [ + { + "id": 78, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 288, + "name": "GoTrueClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 75, + "name": "default" + } + } + ] + }, + { + "id": 79, + "name": "admin", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + }, + { + "id": 80, + "name": "mfa", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Namespace for the MFA methods." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "GoTrueMFAApi" + } + }, + { + "id": 124, + "name": "getSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 487, + "character": 8 + } + ], + "signatures": [ + { + "id": 125, + "name": "getSession", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 126, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 127, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 489, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 129, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 490, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 347, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [129] + } + ] + } + } + }, + { + "id": 130, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 492, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [127, 130] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 131, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 132, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 495, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 133, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 134, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 496, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [134] + } + ] + } + } + }, + { + "id": 135, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 498, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [132, 135] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 136, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 137, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 501, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 138, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 139, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 502, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [139] + } + ] + } + } + }, + { + "id": 140, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 504, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [137, 140] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 141, + "name": "getUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 550, + "character": 8 + } + ], + "signatures": [ + { + "id": 142, + "name": "getUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Gets the current user details if there is an existing session." + }, + "parameters": [ + { + "id": 143, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 102, + "name": "initialize", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 162, + "character": 2 + } + ], + "signatures": [ + { + "id": 103, + "name": "initialize", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 707, + "name": "InitializeResult" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 185, + "name": "onAuthStateChange", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 834, + "character": 2 + } + ], + "signatures": [ + { + "id": 186, + "name": "onAuthStateChange", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Receive a notification every time an auth event happens." + }, + "parameters": [ + { + "id": 187, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A callback function to be invoked when an auth event happens.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 188, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 189, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 190, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 287, + "name": "AuthChangeEvent" + } + }, + { + "id": 191, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 347, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 192, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 193, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 835, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 194, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 195, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 835, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 421, + "name": "Subscription" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [195] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [193] + } + ] + } + } + } + ] + }, + { + "id": 160, + "name": "refreshSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 689, + "character": 8 + } + ], + "signatures": [ + { + "id": 161, + "name": "refreshSession", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." + }, + "parameters": [ + { + "id": 162, + "name": "currentSession", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The current session. If passed in, it must contain a refresh token.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 164, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 689, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [164] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 196, + "name": "resetPasswordForEmail", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 857, + "character": 8 + } + ], + "signatures": [ + { + "id": 197, + "name": "resetPasswordForEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a password reset request to an email address." + }, + "parameters": [ + { + "id": 198, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 199, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 200, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 202, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.\n" + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 861, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 201, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL to send the user to after they click the password reset link." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 860, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [202, 201] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 203, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 204, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 865, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 205, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 206, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 866, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [204, 206] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 208, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 868, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 209, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 868, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [208, 209] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 154, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 626, + "character": 8 + } + ], + "signatures": [ + { + "id": 155, + "name": "setSession", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." + }, + "parameters": [ + { + "id": 156, + "name": "currentSession", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The current session that minimally contains an access token and refresh token.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 157, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 158, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 627, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 159, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 628, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [158, 159] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 112, + "name": "signInWithOAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 340, + "character": 8 + } + ], + "signatures": [ + { + "id": 113, + "name": "signInWithOAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in an existing user via a third-party provider." + }, + "parameters": [ + { + "id": 114, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 478, + "name": "SignInWithOAuthCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 314, + "name": "OAuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 115, + "name": "signInWithOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 355, + "character": 8 + } + ], + "signatures": [ + { + "id": 116, + "name": "signInWithOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins." + }, + "parameters": [ + { + "id": 117, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 462, + "name": "SignInWithPasswordlessCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 109, + "name": "signInWithPassword", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 288, + "character": 8 + } + ], + "signatures": [ + { + "id": 110, + "name": "signInWithPassword", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in an existing user with an email and password or phone and password." + }, + "parameters": [ + { + "id": 111, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 447, + "name": "SignInWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 121, + "name": "signInWithSSO", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 458, + "character": 8 + } + ], + "signatures": [ + { + "id": 122, + "name": "signInWithSSO", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.", + "text": "You can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead.\n\nThis API is experimental and availability is conditional on correct\nsettings on the Auth service.\n", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "parameters": [ + { + "id": 123, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 508, + "name": "SignInWithSSO" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 327, + "name": "SSOResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 181, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 809, + "character": 8 + } + ], + "signatures": [ + { + "id": 182, + "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)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 183, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 184, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 809, + "character": 29 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 727, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [184] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 106, + "name": "signUp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 225, + "character": 8 + } + ], + "signatures": [ + { + "id": 107, + "name": "signUp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" + }, + "parameters": [ + { + "id": 108, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 431, + "name": "SignUpWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 144, + "name": "updateUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 579, + "character": 8 + } + ], + "signatures": [ + { + "id": 145, + "name": "updateUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates user data, if there is a logged in user." + }, + "parameters": [ + { + "id": 146, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 406, + "name": "UserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 336, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 118, + "name": "verifyOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 399, + "character": 8 + } + ], + "signatures": [ + { + "id": 119, + "name": "verifyOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user given a User supplied OTP received via mobile." + }, + "parameters": [ + { + "id": 120, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 489, + "name": "VerifyOtpParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 301, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [76] + }, + { + "title": "Properties", + "kind": 1024, + "children": [79, 80] + }, + { + "title": "Methods", + "kind": 2048, + "children": [124, 141, 102, 185, 160, 196, 154, 112, 115, 109, 121, 181, 106, 144, 118] + } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 82, + "character": 21 + } + ] + }, + { + "id": 356, + "name": "AMREntry", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "An authentication methord reference (AMR) entry.", + "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", + "tags": [ + { + "tag": "see", + "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" + } + ] + }, + "children": [ + { + "id": 357, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Authentication method name." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 152, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 358, + "name": "timestamp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 158, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [357, 358] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 17 + } + ] + }, + { + "id": 411, + "name": "AdminUserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 413, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 280, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 416, + "name": "ban_duration", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Determines how long a user is banned for.", + "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 306, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 420, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 255, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + }, + "inheritedFrom": { + "type": "reference", + "id": 410, + "name": "UserAttributes.data" + } + }, + { + "id": 417, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 407, + "name": "UserAttributes.email" + } + }, + { + "id": 414, + "name": "email_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Confirms the user's email address if set to true.", + "text": "Only a service role can modify.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 287, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 419, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 247, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 409, + "name": "UserAttributes.password" + } + }, + { + "id": 418, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 242, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 408, + "name": "UserAttributes.phone" + } + }, + { + "id": 415, + "name": "phone_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Confirms the user's phone number if set to true.", + "text": "Only a service role can modify.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 412, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 270, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 258, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 406, + "name": "UserAttributes" + } + ] + }, + { + "id": 370, + "name": "Factor", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "A MFA factor.", + "tags": [ + { + "tag": "see", + "text": "{@link GoTrueMFAApi#enroll}" + }, + { + "tag": "see", + "text": "{@link GoTrueMFAApi#listFactors}" + }, + { + "tag": "see", + "text": "{@link GoTrueMFAAdminApi#listFactors}\n" + } + ] + }, + "children": [ + { + "id": 375, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 196, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 373, + "name": "factor_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 191, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 372, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 185, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 371, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 182, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 374, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Factor's status." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 194, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "verified" + }, + { + "type": "literal", + "value": "unverified" + } + ] + } + }, + { + "id": 376, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 197, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [375, 373, 372, 371, 374, 376] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 180, + "character": 17 + } + ] + }, + { + "id": 540, + "name": "GenerateLinkOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 541, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 540, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 542, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL which will be appended to the email link generated." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 542, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [541, 542] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 534, + "character": 17 + } + ] + }, + { + "id": 699, + "name": "GoTrueAdminMFAApi", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Contains the full multi-factor authentication administration API.", + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "children": [ + { + "id": 703, + "name": "deleteFactor", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 704, + "name": "deleteFactor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified.", + "tags": [ + { + "tag": "see", + "text": "{@link GoTrueMFAApi#unenroll}\n" + }, + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "parameters": [ + { + "id": 705, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 683, + "name": "AuthMFAAdminDeleteFactorParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 674, + "name": "AuthMFAAdminDeleteFactorResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 700, + "name": "listFactors", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 701, + "name": "listFactors", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Lists all factors associated to a user." + }, + "parameters": [ + { + "id": 702, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 696, + "name": "AuthMFAAdminListFactorsParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 687, + "name": "AuthMFAAdminListFactorsResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "kind": 2048, + "children": [703, 700] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 876, + "character": 17 + } + ] + }, + { + "id": 654, + "name": "GoTrueMFAApi", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "comment": { + "shortText": "Contains the full multi-factor authentication API." + }, + "children": [ + { + "id": 658, + "name": "challenge", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 659, + "name": "challenge", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." + }, + "parameters": [ + { + "id": 660, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 578, + "name": "MFAChallengeParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 622, + "name": "AuthMFAChallengeResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 667, + "name": "challengeAndVerify", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 668, + "name": "challengeAndVerify", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + }, + "parameters": [ + { + "id": 669, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 581, + "name": "MFAChallengeAndVerifyParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 585, + "name": "AuthMFAVerifyResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 655, + "name": "enroll", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 656, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new `unverified` factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.", + "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to `aal2`.\n\n" + }, + "parameters": [ + { + "id": 657, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 565, + "name": "MFAEnrollParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 598, + "name": "AuthMFAEnrollResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 672, + "name": "getAuthenticatorAssuranceLevel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 673, + "name": "getAuthenticatorAssuranceLevel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", + "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 643, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 670, + "name": "listFactors", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 671, + "name": "listFactors", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the list of MFA factors enabled for this user. For most use cases\nyou should consider using {@link\nGoTrueMFAApi#getAuthenticatorAssuranceLevel}. This uses a cached version\nof the factors and avoids incurring a network call. If you need to update\nthis list, call {@link GoTrueClient#getUser} first.", + "tags": [ + { + "tag": "see", + "text": "{@link GoTrueMFAApi#enroll}" + }, + { + "tag": "see", + "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" + }, + { + "tag": "see", + "text": "{@link GoTrueClient#getUser}\n\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 632, + "name": "AuthMFAListFactorsResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 664, + "name": "unenroll", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 665, + "name": "unenroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unenroll removes a MFA factor.\nA user has to have an `aal2` authenticator level in order to unenroll a `verified` factor." + }, + "parameters": [ + { + "id": 666, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 570, + "name": "MFAUnenrollParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 613, + "name": "AuthMFAUnenrollResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 661, + "name": "verify", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "signatures": [ + { + "id": 662, + "name": "verify", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." + }, + "parameters": [ + { + "id": 663, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 573, + "name": "MFAVerifyParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 585, + "name": "AuthMFAVerifyResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "kind": 2048, + "children": [658, 667, 655, 672, 670, 664, 661] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 759, + "character": 17 + } + ] + }, + { + "id": 347, + "name": "Session", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 350, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 353, + "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": 137, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 352, + "name": "expires_in", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 349, + "name": "provider_refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 348, + "name": "provider_token", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 351, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "A one-time used refresh token that never expires." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 129, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 354, + "name": "token_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 355, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 139, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 384, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [350, 353, 352, 349, 348, 351, 354, 355] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 17 + } + ] + }, + { + "id": 421, + "name": "Subscription", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 422, + "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": 313, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 423, + "name": "callback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 317, + "character": 2 + } + ], + "signatures": [ + { + "id": 424, + "name": "callback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "The function to call every time there is an event. eg: (eventName) => {}" + }, + "parameters": [ + { + "id": 425, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 287, + "name": "AuthChangeEvent" + } + }, + { + "id": 426, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 347, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 427, + "name": "unsubscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 321, + "character": 2 + } + ], + "signatures": [ + { + "id": 428, + "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": [422] + }, + { + "title": "Methods", + "kind": 2048, + "children": [423, 427] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 309, + "character": 17 + } + ] + }, + { + "id": 429, + "name": "UpdatableFactorAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 430, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 325, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [430] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 324, + "character": 17 + } + ] + }, + { + "id": 384, + "name": "User", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 394, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 386, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 211, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 377, + "name": "UserAppMetadata" + } + }, + { + "id": 388, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 213, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 389, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 214, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 398, + "name": "confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 397, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 220, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 391, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 216, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 399, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 224, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 405, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 370, + "name": "Factor" + } + } + }, + { + "id": 385, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 210, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 404, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 229, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 359, + "name": "UserIdentity" + } + } + }, + { + "id": 393, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 218, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 401, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 392, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 217, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 400, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 390, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 215, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 402, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 227, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 403, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 387, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 212, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 381, + "name": "UserMetadata" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 394, 386, 388, 389, 398, 397, 395, 391, 399, 405, 385, 404, 393, 401, 392, 396, 400, + 390, 402, 403, 387 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 209, + "character": 17 + } + ] + }, + { + "id": 377, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 378, + "name": "provider", + "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": [378] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 200, + "character": 17 + } + ], + "indexSignature": { + "id": 379, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 380, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 406, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 410, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 255, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 407, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 409, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 247, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 408, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 242, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [410, 407, 409, 408] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 233, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 411, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 359, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 367, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 168, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 360, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 362, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 164, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 363, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 364, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 365, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 368, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 169, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 366, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 167, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 369, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 170, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 361, + "name": "user_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 163, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [367, 360, 362, 368, 366, 369, 361] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 161, + "character": 17 + } + ] + }, + { + "id": 381, + "name": "UserMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 205, + "character": 17 + } + ], + "indexSignature": { + "id": 382, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 383, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 498, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 499, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 468, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 502, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 473, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 503, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 505, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 477, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 504, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 475, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [505, 504] + } + ] + } + } + }, + { + "id": 500, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The otp sent to the user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 501, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 507, + "name": "EmailOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [499, 502, 500, 501] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 466, + "character": 17 + } + ] + }, + { + "id": 490, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 494, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 454, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 495, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 497, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 463, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 496, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 456, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [497, 496] + } + ] + } + } + }, + { + "id": 491, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 449, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 492, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The otp sent to the user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 493, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 453, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 506, + "name": "MobileOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [494, 491, 492, 493] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 447, + "character": 17 + } + ] + }, + { + "id": 287, + "name": "AuthChangeEvent", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 25, + "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" + }, + { + "type": "reference", + "id": 286, + "name": "AuthChangeEventMFA" + } + ] + } + }, + { + "id": 286, + "name": "AuthChangeEventMFA", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 23, + "character": 12 + } + ], + "type": { + "type": "literal", + "value": "MFA_CHALLENGE_VERIFIED" + } + }, + { + "id": 683, + "name": "AuthMFAAdminDeleteFactorParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 842, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 684, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 685, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the MFA factor to delete." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 844, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 686, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user whose factor is being deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 847, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [685, 686] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 842, + "character": 45 + } + ] + } + } + }, + { + "id": 674, + "name": "AuthMFAAdminDeleteFactorResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 829, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 675, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 676, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 831, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 677, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 678, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 833, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [678] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 831, + "character": 12 + } + ] + } + } + }, + { + "id": 679, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 835, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [676, 679] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 830, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 680, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 681, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 837, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 682, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 837, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [681, 682] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 837, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 696, + "name": "AuthMFAAdminListFactorsParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 866, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 697, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 698, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 868, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [698] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 866, + "character": 44 + } + ] + } + } + }, + { + "id": 687, + "name": "AuthMFAAdminListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 853, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 688, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 689, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 855, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 690, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 691, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All factors attached to the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 857, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 370, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [691] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 855, + "character": 12 + } + ] + } + } + }, + { + "id": 692, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 859, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [689, 692] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 854, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 693, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 694, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 861, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 695, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 861, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [694, 695] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 861, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 622, + "name": "AuthMFAChallengeResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 702, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 623, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 624, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 704, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 625, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 627, + "name": "expires_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 709, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 626, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the newly created challenge." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 706, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [627, 626] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 704, + "character": 12 + } + ] + } + } + }, + { + "id": 628, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 711, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [624, 628] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 703, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 629, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 630, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 713, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 631, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 713, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [630, 631] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 713, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 598, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 659, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 599, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 600, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 661, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 601, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 602, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was just enrolled (in an unverified state)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 663, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 604, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 669, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 605, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 606, + "name": "qr_code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 673, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 607, + "name": "secret", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 678, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 608, + "name": "uri", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 682, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [606, 607, 608] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 669, + "character": 14 + } + ] + } + } + }, + { + "id": 603, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor. Only `totp` supported for now." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 666, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [602, 604, 603] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 661, + "character": 12 + } + ] + } + } + }, + { + "id": 609, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 685, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [600, 609] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 660, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 610, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 611, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 688, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 612, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 689, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [611, 612] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 687, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 643, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 730, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 644, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 645, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 732, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 646, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 649, + "name": "currentAuthenticationMethods", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 749, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 356, + "name": "AMREntry" + } + } + }, + { + "id": 647, + "name": "currentLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Current AAL level of the session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 734, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 642, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 648, + "name": "nextLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", + "tags": [ + { + "tag": "see", + "text": "{@link GoTrueMFAApi#challenge}\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 742, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 642, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [649, 647, 648] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 732, + "character": 12 + } + ] + } + } + }, + { + "id": 650, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 751, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [645, 650] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 731, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 651, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 652, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 753, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 653, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 753, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [652, 653] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 753, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 632, + "name": "AuthMFAListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 715, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 633, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 634, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 635, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 636, + "name": "all", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All available factors (verified and unverified)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 719, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 370, + "name": "Factor" + } + } + }, + { + "id": 637, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified TOTP factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 722, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 370, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [636, 637] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 717, + "character": 12 + } + ] + } + } + }, + { + "id": 638, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 724, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [634, 638] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 716, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 639, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 640, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 726, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 641, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 726, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [640, 641] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 726, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 613, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 692, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 614, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 615, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 694, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 616, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 617, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 696, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [617] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 694, + "character": 12 + } + ] + } + } + }, + { + "id": 618, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 698, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [615, 618] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 693, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 619, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 620, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 700, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 621, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 700, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [620, 621] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 700, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 585, + "name": "AuthMFAVerifyResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 634, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 586, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 587, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 636, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 588, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 589, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "New access token (JWT) after successful verification." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 638, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 591, + "name": "expires_in", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Number of seconds in which the access token will expire." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 644, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 592, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Refresh token you can use to obtain new access tokens when expired." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 647, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 590, + "name": "token_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of token, typically `Bearer`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 641, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 593, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Updated user profile." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 650, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 384, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [589, 591, 592, 590, 593] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 636, + "character": 12 + } + ] + } + } + }, + { + "id": 594, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 652, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [587, 594] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 635, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 596, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 597, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 656, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [596, 597] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 654, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 301, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 53, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 303, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 304, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 306, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 57, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 347, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 305, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 384, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [306, 305] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 55, + "character": 12 + } + ] + } + } + }, + { + "id": 307, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [303, 307] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 54, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 308, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 309, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 310, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 312, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 311, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [312, 311] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 12 + } + ] + } + } + }, + { + "id": 313, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [309, 313] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 642, + "name": "AuthenticatorAssuranceLevels", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 728, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "aal1" + }, + { + "type": "literal", + "value": "aal2" + } + ] + } + }, + { + "id": 710, + "name": "CallRefreshTokenResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 711, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 713, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 910, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 712, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 909, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 347, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [713, 712] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 908, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 714, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 716, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 914, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + }, + { + "id": 715, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 913, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [716, 715] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 912, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 507, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 482, + "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": 534, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 523, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 535, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 537, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 526, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 538, + "name": "newEmail", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 530, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 539, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 531, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 540, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 536, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 524, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [537, 538, 539, 536] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 523, + "character": 44 + } + ] + } + } + }, + { + "id": 524, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 525, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 527, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 512, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 528, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 513, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 540, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 526, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [527, 528, 526] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 46 + } + ] + } + } + }, + { + "id": 543, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 545, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 518, + "name": "GenerateSignupLinkParams" + }, + { + "type": "reference", + "id": 524, + "name": "GenerateInviteOrMagiclinkParams" + }, + { + "type": "reference", + "id": 529, + "name": "GenerateRecoveryLinkParams" + }, + { + "type": "reference", + "id": 534, + "name": "GenerateEmailChangeLinkParams" + } + ] + } + }, + { + "id": 557, + "name": "GenerateLinkProperties", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The properties related to the email link generated" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 568, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 558, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 559, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 573, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 560, + "name": "email_otp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 578, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 561, + "name": "hashed_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The hashed token appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 582, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 562, + "name": "redirect_to", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The URL appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 584, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 563, + "name": "verification_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The verification type that the email link is associated to." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 586, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 564, + "name": "GenerateLinkType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [559, 560, 561, 562, 563] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 568, + "character": 37 + } + ] + } + } + }, + { + "id": 544, + "name": "GenerateLinkResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 551, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 545, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 546, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 553, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 547, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 548, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 554, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 557, + "name": "GenerateLinkProperties" + } + }, + { + "id": 549, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 555, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 384, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [548, 549] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 553, + "character": 12 + } + ] + } + } + }, + { + "id": 550, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 557, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [546, 550] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 552, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 551, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 552, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 560, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 553, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 554, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 561, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 555, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 562, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [554, 555] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 560, + "character": 12 + } + ] + } + } + }, + { + "id": 556, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 564, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [552, 556] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 559, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 564, + "name": "GenerateLinkType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 589, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "signup" + }, + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + }, + { + "type": "literal", + "value": "recovery" + }, + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + }, + { + "id": 529, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 516, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 530, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 532, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 519, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 533, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 540, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 531, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 517, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [532, 533, 531] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 516, + "character": 41 + } + ] + } + } + }, + { + "id": 518, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 502, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 519, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 521, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 504, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 523, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 506, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 540, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 522, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 505, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 520, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 503, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [521, 523, 522, 520] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 502, + "character": 39 + } + ] + } + } + }, + { + "id": 288, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 289, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 297, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 296, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 300, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 291, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 38, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 292, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 38, + "character": 12 + } + ], + "indexSignature": { + "id": 293, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 294, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 298, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 46, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 299, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 706, + "name": "SupportedStorage" + } + }, + { + "id": 295, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 290, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [297, 296, 300, 291, 298, 299, 295, 290] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 34 + } + ] + } + } + }, + { + "id": 707, + "name": "InitializeResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 708, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 709, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 727, + "name": "AuthError" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [709] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 31 + } + ] + } + } + }, + { + "id": 581, + "name": "MFAChallengeAndVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 627, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 582, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 584, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 631, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 583, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being verified. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 629, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [584, 583] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 627, + "character": 42 + } + ] + } + } + }, + { + "id": 578, + "name": "MFAChallengeParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 622, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 579, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 580, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor to be challenged. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 624, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [580] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 622, + "character": 33 + } + ] + } + } + }, + { + "id": 565, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 597, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 566, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 567, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 599, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 569, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 603, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 568, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [567, 569, 568] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 597, + "character": 30 + } + ] + } + } + }, + { + "id": 570, + "name": "MFAUnenrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 606, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 571, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 572, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 608, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [572] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 606, + "character": 32 + } + ] + } + } + }, + { + "id": 573, + "name": "MFAVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 611, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 574, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "challengeId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the challenge being verified. Returned in challenge()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 616, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 577, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 619, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 575, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being verified. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 613, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [576, 577, 575] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 611, + "character": 30 + } + ] + } + } + }, + { + "id": 506, + "name": "MobileOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 481, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone_change" + } + ] + } + }, + { + "id": 314, + "name": "OAuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 315, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 316, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 317, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 318, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 285, + "name": "Provider" + } + }, + { + "id": 319, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [318, 319] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 12 + } + ] + } + } + }, + { + "id": 320, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [316, 320] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 321, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 322, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 323, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 324, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 285, + "name": "Provider" + } + }, + { + "id": 325, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [324, 325] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 12 + } + ] + } + } + }, + { + "id": 326, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [322, 326] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 717, + "name": "PageParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 917, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 718, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 719, + "name": "page", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The page number" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 919, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 720, + "name": "perPage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Number of items returned per page" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 921, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [719, 720] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 917, + "character": 25 + } + ] + } + } + }, + { + "id": 285, + "name": "Provider", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 5, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "apple" + }, + { + "type": "literal", + "value": "azure" + }, + { + "type": "literal", + "value": "bitbucket" + }, + { + "type": "literal", + "value": "discord" + }, + { + "type": "literal", + "value": "facebook" + }, + { + "type": "literal", + "value": "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": 327, + "name": "SSOResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 328, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 329, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 330, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 331, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "URL to take the user to (in a browser) to complete SSO." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [331] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 12 + } + ] + } + } + }, + { + "id": 332, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [329, 332] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 86, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 333, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 334, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 94, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 335, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [334, 335] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 478, + "name": "SignInWithOAuthCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 433, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 479, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 481, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 436, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 482, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 485, + "name": "queryParams", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "An object of query params" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 442, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 486, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 442, + "character": 18 + } + ], + "indexSignature": { + "id": 487, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 488, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 483, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 438, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 484, + "name": "scopes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A space-separated list of scopes granted to the OAuth application." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 440, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [485, 483, 484] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 436, + "character": 12 + } + ] + } + } + }, + { + "id": 480, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 285, + "name": "Provider" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [481, 480] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 433, + "character": 41 + } + ] + } + } + }, + { + "id": 447, + "name": "SignInWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 363, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 448, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 449, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 366, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 369, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 452, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 454, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 377, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 375, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [454, 453] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 369, + "character": 16 + } + ] + } + } + }, + { + "id": 450, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [449, 451, 450] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 455, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 458, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 459, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 461, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 393, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 391, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [461, 460] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 16 + } + ] + } + } + }, + { + "id": 457, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 384, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 456, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [458, 457, 456] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 380, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 462, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 397, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 463, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 464, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 400, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 465, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 401, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 466, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 470, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 469, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 411, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 467, + "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": 403, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 405, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [470, 469, 467, 468] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 401, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [464, 465] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 398, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 471, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 473, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 419, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 474, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 477, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 429, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 427, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 475, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [477, 476, 475] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 419, + "character": 16 + } + ] + } + } + }, + { + "id": 472, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 418, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [473, 472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 416, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 508, + "name": "SignInWithSSO", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 484, + "character": 12 + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 509, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 510, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 485, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 513, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 489, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 512, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they have signed-in." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [513, 512] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 485, + "character": 12 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [510] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 484, + "character": 28 + } + ] + } + }, + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 514, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 515, + "name": "providerId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "UUID of the SSO provider to invoke single-sign on to." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 494, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [515] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 492, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 516, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 517, + "name": "domain", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Domain name of the organization for which to invoke single-sign on." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 498, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [517] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 496, + "character": 4 + } + ] + } + } + ] + } + ] + } + }, + { + "id": 431, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 328, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 432, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 433, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 435, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 436, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 439, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 437, + "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": 336, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [439, 438, 437] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 16 + } + ] + } + } + }, + { + "id": 434, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [433, 435, 434] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 443, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 352, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 444, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 446, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 360, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 358, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [446, 445] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 352, + "character": 16 + } + ] + } + } + }, + { + "id": 442, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 351, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 349, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [443, 442, 441] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 706, + "name": "SupportedStorage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 903, + "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": 336, + "name": "UserResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 98, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 337, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 338, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 339, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 340, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 384, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [340] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 12 + } + ] + } + } + }, + { + "id": 341, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [338, 341] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 342, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 343, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 344, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 345, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [345] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 12 + } + ] + } + } + }, + { + "id": 346, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [343, 346] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 489, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 446, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 490, + "name": "VerifyMobileOtpParams" + }, + { + "type": "reference", + "id": 498, + "name": "VerifyEmailOtpParams" + } + ] + } + }, + { + "id": 724, + "name": "isAuthApiError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 32, + "character": 16 + } + ], + "signatures": [ + { + "id": 725, + "name": "isAuthApiError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 726, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 732, + "name": "AuthApiError" + } + } + } + ] + }, + { + "id": 721, + "name": "isAuthError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 10, + "character": 16 + } + ], + "signatures": [ + { + "id": 722, + "name": "isAuthError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 723, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 727, + "name": "AuthError" + } + } + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [732, 727, 792, 779, 817, 767, 745, 752, 1, 75] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [356, 411, 370, 540, 699, 654, 347, 421, 429, 384, 377, 406, 359, 381, 498, 490] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 287, 286, 683, 674, 696, 687, 622, 598, 643, 632, 613, 585, 301, 642, 710, 507, 534, 524, + 543, 557, 544, 564, 529, 518, 288, 707, 581, 578, 565, 570, 573, 506, 314, 717, 285, 327, + 478, 447, 462, 508, 431, 706, 336, 489 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [724, 721] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] +} diff --git a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index 00d85e8fe45..e1e43bc04ec 100644 --- a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -184,11 +184,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 742, - 741, - 743 - ] + "children": [742, 741, 743] } ] } @@ -201,23 +197,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 733 - ] + "children": [733] }, { "title": "Properties", "kind": 1024, - "children": [ - 737 - ] + "children": [737] }, { "title": "Methods", "kind": 2048, - "children": [ - 738 - ] + "children": [738] } ], "sources": [ @@ -296,9 +286,7 @@ { "title": "Constructors", "kind": 512, - "children": [ - 728 - ] + "children": [728] } ], "sources": [ @@ -436,10 +424,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 799, - 798 - ] + "children": [799, 798] } ] } @@ -537,10 +522,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 803, - 802 - ] + "children": [803, 802] } ] } @@ -694,10 +676,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 813, - 812 - ] + "children": [813, 812] } ] } @@ -768,12 +747,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 810, - 808, - 807, - 809 - ] + "children": [810, 808, 807, 809] } ] } @@ -796,25 +770,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 793 - ] + "children": [793] }, { "title": "Properties", "kind": 1024, - "children": [ - 800, - 814, - 815 - ] + "children": [800, 814, 815] }, { "title": "Methods", "kind": 2048, - "children": [ - 804 - ] + "children": [804] } ], "sources": [ @@ -1027,11 +993,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 789, - 788, - 790 - ] + "children": [789, 788, 790] } ] } @@ -1054,24 +1016,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 780 - ] + "children": [780] }, { "title": "Properties", "kind": 1024, - "children": [ - 783, - 784 - ] + "children": [783, 784] }, { "title": "Methods", "kind": 2048, - "children": [ - 785 - ] + "children": [785] } ], "sources": [ @@ -1295,11 +1250,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 828, - 827, - 829 - ] + "children": [828, 827, 829] } ] } @@ -1322,24 +1273,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 818 - ] + "children": [818] }, { "title": "Properties", "kind": 1024, - "children": [ - 822, - 823 - ] + "children": [822, 823] }, { "title": "Methods", "kind": 2048, - "children": [ - 824 - ] + "children": [824] } ], "sources": [ @@ -1539,11 +1483,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 776, - 775, - 777 - ] + "children": [776, 775, 777] } ] } @@ -1566,24 +1506,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 768 - ] + "children": [768] }, { "title": "Properties", "kind": 1024, - "children": [ - 770, - 771 - ] + "children": [770, 771] }, { "title": "Methods", "kind": 2048, - "children": [ - 772 - ] + "children": [772] } ], "sources": [ @@ -1693,16 +1626,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 746 - ] + "children": [746] }, { "title": "Properties", "kind": 1024, - "children": [ - 750 - ] + "children": [750] } ], "sources": [ @@ -1931,11 +1860,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 764, - 763, - 765 - ] + "children": [764, 763, 765] } ] } @@ -1948,24 +1873,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 753 - ] + "children": [753] }, { "title": "Properties", "kind": 1024, - "children": [ - 758, - 759 - ] + "children": [758, 759] }, { "title": "Methods", "kind": 2048, - "children": [ - 760 - ] + "children": [760] } ], "sources": [ @@ -2210,11 +2128,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 11, - 7, - 6 - ] + "children": [11, 7, 6] } ] } @@ -2530,17 +2444,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -2805,12 +2709,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -2940,11 +2839,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -3056,11 +2951,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -3202,12 +3093,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -3401,10 +3287,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 39, - 38 - ] + "children": [39, 38] } ] } @@ -3541,10 +3424,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 719, - 720 - ] + "children": [719, 720] } ], "sources": [ @@ -3624,9 +3504,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 52 - ] + "children": [52] } ] } @@ -3655,10 +3533,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 50, - 53 - ] + "children": [50, 53] } ] } @@ -3716,9 +3591,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 57 - ] + "children": [57] } ] } @@ -3748,10 +3621,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 55, - 58 - ] + "children": [55, 58] } ] } @@ -3868,10 +3738,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 31, - 32 - ] + "children": [31, 32] } ] } @@ -4177,17 +4044,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -4229,30 +4086,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 16 - ] + "children": [16] }, { "title": "Methods", "kind": 2048, - "children": [ - 43, - 66, - 40, - 59, - 33, - 46, - 27, - 62 - ] + "children": [43, 66, 40, 59, 33, 46, 27, 62] } ], "sources": [ @@ -4528,16 +4372,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 297, - 296, - 300, - 291, - 298, - 299, - 295, - 290 - ] + "children": [297, 296, 300, 291, 298, 299, 295, 290] } ], "sources": [ @@ -4689,9 +4524,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 129 - ] + "children": [129] } ] } @@ -4720,10 +4553,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 127, - 130 - ] + "children": [127, 130] } ] } @@ -4782,9 +4612,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 134 - ] + "children": [134] } ] } @@ -4814,10 +4642,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 132, - 135 - ] + "children": [132, 135] } ] } @@ -4876,9 +4701,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 139 - ] + "children": [139] } ] } @@ -4907,10 +4730,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 137, - 140 - ] + "children": [137, 140] } ] } @@ -5169,9 +4989,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 195 - ] + "children": [195] } ] } @@ -5182,9 +5000,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 193 - ] + "children": [193] } ] } @@ -5259,9 +5075,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 164 - ] + "children": [164] } ] } @@ -5388,10 +5202,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 202, - 201 - ] + "children": [202, 201] } ] } @@ -5461,10 +5272,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 204, - 206 - ] + "children": [204, 206] } ] } @@ -5520,10 +5328,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208, - 209 - ] + "children": [208, 209] } ] } @@ -5621,10 +5426,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 158, - 159 - ] + "children": [158, 159] } ] } @@ -5837,11 +5639,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 485, - 483, - 484 - ] + "children": [485, 483, 484] } ], "sources": [ @@ -5881,10 +5679,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 481, - 480 - ] + "children": [481, 480] } ], "sources": [ @@ -6118,12 +5913,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 470, - 469, - 467, - 468 - ] + "children": [470, 469, 467, 468] } ], "sources": [ @@ -6141,10 +5931,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 464, - 465 - ] + "children": [464, 465] } ], "sources": [ @@ -6264,11 +6051,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 477, - 476, - 475 - ] + "children": [477, 476, 475] } ], "sources": [ @@ -6307,10 +6090,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 473, - 472 - ] + "children": [473, 472] } ], "sources": [ @@ -6500,10 +6280,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 454, - 453 - ] + "children": [454, 453] } ], "sources": [ @@ -6542,11 +6319,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 449, - 451, - 450 - ] + "children": [449, 451, 450] } ], "sources": [ @@ -6643,10 +6416,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 461, - 460 - ] + "children": [461, 460] } ], "sources": [ @@ -6706,11 +6476,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 458, - 457, - 456 - ] + "children": [458, 457, 456] } ], "sources": [ @@ -6885,10 +6651,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 513, - 512 - ] + "children": [513, 512] } ], "sources": [ @@ -6906,9 +6669,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 510 - ] + "children": [510] } ], "sources": [ @@ -6958,9 +6719,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 515 - ] + "children": [515] } ], "sources": [ @@ -7007,9 +6766,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 517 - ] + "children": [517] } ], "sources": [ @@ -7114,9 +6871,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 184 - ] + "children": [184] } ] } @@ -7309,11 +7064,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 439, - 438, - 437 - ] + "children": [439, 438, 437] } ], "sources": [ @@ -7352,11 +7103,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 433, - 435, - 434 - ] + "children": [433, 435, 434] } ], "sources": [ @@ -7453,10 +7200,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 446, - 445 - ] + "children": [446, 445] } ], "sources": [ @@ -7516,11 +7260,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 443, - 442, - 441 - ] + "children": [443, 442, 441] } ], "sources": [ @@ -7693,12 +7433,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 410, - 407, - 409, - 408 - ] + "children": [410, 407, 409, 408] } ], "sources": [ @@ -7873,10 +7608,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -7951,12 +7683,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -8070,10 +7797,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -8127,12 +7851,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -8170,38 +7889,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 76 - ] + "children": [76] }, { "title": "Properties", "kind": 1024, - "children": [ - 79, - 80 - ] + "children": [79, 80] }, { "title": "Methods", "kind": 2048, - "children": [ - 124, - 141, - 102, - 185, - 160, - 196, - 154, - 112, - 115, - 109, - 121, - 181, - 106, - 144, - 118 - ] + "children": [124, 141, 102, 185, 160, 196, 154, 112, 115, 109, 121, 181, 106, 144, 118] } ], "sources": [ @@ -8276,10 +7974,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 357, - 358 - ] + "children": [357, 358] } ], "sources": [ @@ -8535,17 +8230,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 413, - 416, - 420, - 417, - 414, - 419, - 418, - 415, - 412 - ] + "children": [413, 416, 420, 417, 414, 419, 418, 415, 412] } ], "sources": [ @@ -8723,14 +8408,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 375, - 373, - 372, - 371, - 374, - 376 - ] + "children": [375, 373, 372, 371, 374, 376] } ], "sources": [ @@ -8800,10 +8478,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 541, - 542 - ] + "children": [541, 542] } ], "sources": [ @@ -8944,10 +8619,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 685, - 686 - ] + "children": [685, 686] } ], "sources": [ @@ -9062,9 +8734,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 698 - ] + "children": [698] } ], "sources": [ @@ -9101,10 +8771,7 @@ { "title": "Methods", "kind": 2048, - "children": [ - 703, - 700 - ] + "children": [703, 700] } ], "sources": [ @@ -9200,9 +8867,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 580 - ] + "children": [580] } ], "sources": [ @@ -9330,10 +8995,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 584, - 583 - ] + "children": [584, 583] } ], "sources": [ @@ -9487,11 +9149,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 567, - 569, - 568 - ] + "children": [567, 569, 568] } ], "sources": [ @@ -9677,9 +9335,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 572 - ] + "children": [572] } ], "sources": [ @@ -9828,11 +9484,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 576, - 577, - 575 - ] + "children": [576, 577, 575] } ], "sources": [ @@ -9869,15 +9521,7 @@ { "title": "Methods", "kind": 2048, - "children": [ - 658, - 667, - 655, - 672, - 670, - 664, - 661 - ] + "children": [658, 667, 655, 672, 670, 664, 661] } ], "sources": [ @@ -10087,16 +9731,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 350, - 353, - 352, - 349, - 348, - 351, - 354, - 355 - ] + "children": [350, 353, 352, 349, 348, 351, 354, 355] } ], "sources": [ @@ -10296,17 +9931,12 @@ { "title": "Properties", "kind": 1024, - "children": [ - 422 - ] + "children": [422] }, { "title": "Methods", "kind": 2048, - "children": [ - 423, - 427 - ] + "children": [423, 427] } ], "sources": [ @@ -10347,9 +9977,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 430 - ] + "children": [430] } ], "sources": [ @@ -10793,27 +10421,8 @@ "title": "Properties", "kind": 1024, "children": [ - 394, - 386, - 388, - 389, - 398, - 397, - 395, - 391, - 399, - 405, - 385, - 404, - 393, - 401, - 392, - 396, - 400, - 390, - 402, - 403, - 387 + 394, 386, 388, 389, 398, 397, 395, 391, 399, 405, 385, 404, 393, 401, 392, 396, 400, + 390, 402, 403, 387 ] } ], @@ -10857,9 +10466,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 378 - ] + "children": [378] } ], "sources": [ @@ -10998,12 +10605,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 410, - 407, - 409, - 408 - ] + "children": [410, 407, 409, 408] } ], "sources": [ @@ -11190,15 +10792,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 367, - 360, - 362, - 368, - 366, - 369, - 361 - ] + "children": [367, 360, 362, 368, 366, 369, 361] } ], "sources": [ @@ -11349,10 +10943,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -11406,12 +10997,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -11510,10 +11096,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -11588,12 +11171,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -11760,10 +11338,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 685, - 686 - ] + "children": [685, 686] } ], "sources": [ @@ -11857,9 +11432,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 678 - ] + "children": [678] } ], "sources": [ @@ -11895,10 +11468,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 676, - 679 - ] + "children": [676, 679] } ], "sources": [ @@ -11961,10 +11531,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 681, - 682 - ] + "children": [681, 682] } ], "sources": [ @@ -12035,9 +11602,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 698 - ] + "children": [698] } ], "sources": [ @@ -12135,9 +11700,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 691 - ] + "children": [691] } ], "sources": [ @@ -12173,10 +11736,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 689, - 692 - ] + "children": [689, 692] } ], "sources": [ @@ -12239,10 +11799,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 694, - 695 - ] + "children": [694, 695] } ], "sources": [ @@ -12351,10 +11908,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 627, - 626 - ] + "children": [627, 626] } ], "sources": [ @@ -12390,10 +11944,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 624, - 628 - ] + "children": [624, 628] } ], "sources": [ @@ -12456,10 +12007,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 630, - 631 - ] + "children": [630, 631] } ], "sources": [ @@ -12635,11 +12183,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 606, - 607, - 608 - ] + "children": [606, 607, 608] } ], "sources": [ @@ -12678,11 +12222,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 602, - 604, - 603 - ] + "children": [602, 604, 603] } ], "sources": [ @@ -12718,10 +12258,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 600, - 609 - ] + "children": [600, 609] } ], "sources": [ @@ -12784,10 +12321,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 611, - 612 - ] + "children": [611, 612] } ], "sources": [ @@ -12947,11 +12481,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 649, - 647, - 648 - ] + "children": [649, 647, 648] } ], "sources": [ @@ -12987,10 +12517,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 645, - 650 - ] + "children": [645, 650] } ], "sources": [ @@ -13053,10 +12580,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 652, - 653 - ] + "children": [652, 653] } ], "sources": [ @@ -13173,10 +12697,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 636, - 637 - ] + "children": [636, 637] } ], "sources": [ @@ -13212,10 +12733,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 634, - 638 - ] + "children": [634, 638] } ], "sources": [ @@ -13278,10 +12796,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 640, - 641 - ] + "children": [640, 641] } ], "sources": [ @@ -13369,9 +12884,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 617 - ] + "children": [617] } ], "sources": [ @@ -13407,10 +12920,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 615, - 618 - ] + "children": [615, 618] } ], "sources": [ @@ -13473,10 +12983,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 620, - 621 - ] + "children": [620, 621] } ], "sources": [ @@ -13649,13 +13156,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 589, - 591, - 592, - 590, - 593 - ] + "children": [589, 591, 592, 590, 593] } ], "sources": [ @@ -13691,10 +13192,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 587, - 594 - ] + "children": [587, 594] } ], "sources": [ @@ -13757,10 +13255,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 596, - 597 - ] + "children": [596, 597] } ], "sources": [ @@ -13883,10 +13378,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 306, - 305 - ] + "children": [306, 305] } ], "sources": [ @@ -13922,10 +13414,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 303, - 307 - ] + "children": [303, 307] } ], "sources": [ @@ -14009,10 +13498,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 312, - 311 - ] + "children": [312, 311] } ], "sources": [ @@ -14049,10 +13535,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 309, - 313 - ] + "children": [309, 313] } ], "sources": [ @@ -14161,10 +13644,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 713, - 712 - ] + "children": [713, 712] } ], "sources": [ @@ -14227,10 +13707,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 716, - 715 - ] + "children": [716, 715] } ], "sources": [ @@ -14413,12 +13890,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -14548,11 +14020,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -14704,12 +14172,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -14839,11 +14302,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 527, - 528, - 526 - ] + "children": [527, 528, 526] } ], "sources": [ @@ -14955,11 +14414,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -15101,12 +14556,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 537, - 538, - 539, - 536 - ] + "children": [537, 538, 539, 536] } ], "sources": [ @@ -15258,13 +14708,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 559, - 560, - 561, - 562, - 563 - ] + "children": [559, 560, 561, 562, 563] } ], "sources": [ @@ -15367,10 +14811,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 548, - 549 - ] + "children": [548, 549] } ], "sources": [ @@ -15406,10 +14847,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 546, - 550 - ] + "children": [546, 550] } ], "sources": [ @@ -15493,10 +14931,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 554, - 555 - ] + "children": [554, 555] } ], "sources": [ @@ -15533,10 +14968,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 552, - 556 - ] + "children": [552, 556] } ], "sources": [ @@ -15693,11 +15125,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 532, - 533, - 531 - ] + "children": [532, 533, 531] } ], "sources": [ @@ -15833,12 +15261,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 521, - 523, - 522, - 520 - ] + "children": [521, 523, 522, 520] } ], "sources": [ @@ -16075,16 +15498,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 297, - 296, - 300, - 291, - 298, - 299, - 295, - 290 - ] + "children": [297, 296, 300, 291, 298, 299, 295, 290] } ], "sources": [ @@ -16152,9 +15566,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 709 - ] + "children": [709] } ], "sources": [ @@ -16236,10 +15648,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 584, - 583 - ] + "children": [584, 583] } ], "sources": [ @@ -16300,9 +15709,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 580 - ] + "children": [580] } ], "sources": [ @@ -16409,11 +15816,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 567, - 569, - 568 - ] + "children": [567, 569, 568] } ], "sources": [ @@ -16474,9 +15877,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 572 - ] + "children": [572] } ], "sources": [ @@ -16579,11 +15980,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 576, - 577, - 575 - ] + "children": [576, 577, 575] } ], "sources": [ @@ -16712,10 +16109,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 318, - 319 - ] + "children": [318, 319] } ], "sources": [ @@ -16751,10 +16145,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 316, - 320 - ] + "children": [316, 320] } ], "sources": [ @@ -16839,10 +16230,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 324, - 325 - ] + "children": [324, 325] } ], "sources": [ @@ -16879,10 +16267,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322, - 326 - ] + "children": [322, 326] } ], "sources": [ @@ -16970,10 +16355,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 719, - 720 - ] + "children": [719, 720] } ], "sources": [ @@ -17145,9 +16527,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 331 - ] + "children": [331] } ], "sources": [ @@ -17183,10 +16563,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 329, - 332 - ] + "children": [329, 332] } ], "sources": [ @@ -17249,10 +16626,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 334, - 335 - ] + "children": [334, 335] } ], "sources": [ @@ -17423,11 +16797,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 485, - 483, - 484 - ] + "children": [485, 483, 484] } ], "sources": [ @@ -17467,10 +16837,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 481, - 480 - ] + "children": [481, 480] } ], "sources": [ @@ -17605,10 +16972,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 454, - 453 - ] + "children": [454, 453] } ], "sources": [ @@ -17647,11 +17011,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 449, - 451, - 450 - ] + "children": [449, 451, 450] } ], "sources": [ @@ -17748,10 +17108,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 461, - 460 - ] + "children": [461, 460] } ], "sources": [ @@ -17811,11 +17168,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 458, - 457, - 456 - ] + "children": [458, 457, 456] } ], "sources": [ @@ -17998,12 +17351,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 470, - 469, - 467, - 468 - ] + "children": [470, 469, 467, 468] } ], "sources": [ @@ -18021,10 +17369,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 464, - 465 - ] + "children": [464, 465] } ], "sources": [ @@ -18144,11 +17489,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 477, - 476, - 475 - ] + "children": [477, 476, 475] } ], "sources": [ @@ -18187,10 +17528,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 473, - 472 - ] + "children": [473, 472] } ], "sources": [ @@ -18305,10 +17643,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 513, - 512 - ] + "children": [513, 512] } ], "sources": [ @@ -18326,9 +17661,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 510 - ] + "children": [510] } ], "sources": [ @@ -18378,9 +17711,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 515 - ] + "children": [515] } ], "sources": [ @@ -18427,9 +17758,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 517 - ] + "children": [517] } ], "sources": [ @@ -18591,11 +17920,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 439, - 438, - 437 - ] + "children": [439, 438, 437] } ], "sources": [ @@ -18634,11 +17959,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 433, - 435, - 434 - ] + "children": [433, 435, 434] } ], "sources": [ @@ -18735,10 +18056,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 446, - 445 - ] + "children": [446, 445] } ], "sources": [ @@ -18798,11 +18116,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 443, - 442, - 441 - ] + "children": [443, 442, 441] } ], "sources": [ @@ -18939,9 +18253,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 340 - ] + "children": [340] } ], "sources": [ @@ -18977,10 +18289,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 338, - 341 - ] + "children": [338, 341] } ], "sources": [ @@ -19046,9 +18355,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 345 - ] + "children": [345] } ], "sources": [ @@ -19085,10 +18392,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 343, - 346 - ] + "children": [343, 346] } ], "sources": [ @@ -19207,10 +18511,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 497, - 496 - ] + "children": [497, 496] } ] } @@ -19285,12 +18586,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 494, - 491, - 492, - 493 - ] + "children": [494, 491, 492, 493] } ], "sources": [ @@ -19404,10 +18700,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 505, - 504 - ] + "children": [505, 504] } ] } @@ -19461,12 +18754,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 499, - 502, - 500, - 501 - ] + "children": [499, 502, 500, 501] } ], "sources": [ @@ -19577,98 +18865,26 @@ { "title": "Classes", "kind": 128, - "children": [ - 732, - 727, - 792, - 779, - 817, - 767, - 745, - 752, - 1, - 75 - ] + "children": [732, 727, 792, 779, 817, 767, 745, 752, 1, 75] }, { "title": "Interfaces", "kind": 256, - "children": [ - 356, - 411, - 370, - 540, - 699, - 654, - 347, - 421, - 429, - 384, - 377, - 406, - 359, - 381, - 498, - 490 - ] + "children": [356, 411, 370, 540, 699, 654, 347, 421, 429, 384, 377, 406, 359, 381, 498, 490] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 287, - 286, - 683, - 674, - 696, - 687, - 622, - 598, - 643, - 632, - 613, - 585, - 301, - 642, - 710, - 507, - 534, - 524, - 543, - 557, - 544, - 564, - 529, - 518, - 288, - 707, - 581, - 578, - 565, - 570, - 573, - 506, - 314, - 717, - 285, - 327, - 478, - 447, - 462, - 508, - 431, - 706, - 336, - 489 + 287, 286, 683, 674, 696, 687, 622, 598, 643, 632, 613, 585, 301, 642, 710, 507, 534, 524, + 543, 557, 544, 564, 529, 518, 288, 707, 581, 578, 565, 570, 573, 506, 314, 717, 285, 327, + 478, 447, 462, 508, 431, 706, 336, 489 ] }, { "title": "Functions", "kind": 64, - "children": [ - 724, - 721 - ] + "children": [724, 721] } ], "sources": [ @@ -19678,4 +18894,4 @@ "character": 0 } ] -} \ No newline at end of file +} diff --git a/spec/enrichments/tsdoc_v2/postgrest.json b/spec/enrichments/tsdoc_v2/postgrest.json index 3802fc61535..bdb5893958f 100644 --- a/spec/enrichments/tsdoc_v2/postgrest.json +++ b/spec/enrichments/tsdoc_v2/postgrest.json @@ -1,12380 +1,12182 @@ { - "id": 0, - "name": "@supabase/postgrest-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 498, - "name": "PostgrestBuilder", - "kind": 128, - "kindString": "Class", - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 499, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 18, - "character": 2 - } - ], - "signatures": [ - { - "id": 500, - "name": "new PostgrestBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 501, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 502, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 515, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 507, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 510, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 512, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 513, - "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": 514, - "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": 505, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 503, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 506, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 508, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 509, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - }, - { - "id": 504, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 518, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 519, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 520, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 521, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 522, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 524, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 526, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 528, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - }, - { - "id": 516, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 517, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 499 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 518, - 516 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 5, - "character": 30 - } - ], - "typeParameter": [ - { - "id": 530, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 401, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - }, - { - "id": 1, - "name": "PostgrestClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "PostgREST client." - }, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new PostgrestClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Creates a PostgREST client." - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "URL of the PostgREST endpoint" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 12, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 50, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 14, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Custom fetch\n" - }, - "parameters": [ - { - "id": 15, - "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": 16, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 10, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Custom headers" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 48, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 11, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Postgres schema to switch to" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 49, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 12, - 10, - 11 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 1, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 22, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 23, - "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": 24, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 18, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 19, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - }, - { - "id": 17, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 25, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 26, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "typeParameter": [ - { - "id": 27, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 29, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "reference", - "id": 27, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 28, - "name": "Table" - } - ], - "name": "default" - } - }, - { - "id": 30, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "typeParameter": [ - { - "id": 31, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 33, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "reference", - "id": 31, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 32, - "name": "View" - } - ], - "name": "default" - } - }, - { - "id": 34, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "parameters": [ - { - "id": 35, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The table or view name to query\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 36, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 102, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a function call." - }, - "typeParameter": [ - { - "id": 38, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 40, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The function name to call" - }, - "type": { - "type": "reference", - "id": 38, - "name": "FunctionName" - } - }, - { - "id": 41, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The arguments to pass to the function call" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 113, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 44, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 112, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 45, - 44 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 2 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 20, - 18, - 19, - 17 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 25, - 36 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 17, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 46, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 47, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 48, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 112, - "name": "PostgrestFilterBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 113, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "signatures": [ - { - "id": 114, - "name": "new PostgrestFilterBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 115, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 116, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 117, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 118, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 403, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 402, - "name": "default.constructor" - } - }, - { - "id": 383, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 480, - "name": "default.allowEmpty" - } - }, - { - "id": 375, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 472, - "name": "default.body" - } - }, - { - "id": 378, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 380, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 381, - "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": 382, - "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" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 475, - "name": "default.fetch" - } - }, - { - "id": 373, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "inheritedFrom": { - "type": "reference", - "id": 470, - "name": "default.headers" - } - }, - { - "id": 371, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 468, - "name": "default.method" - } - }, - { - "id": 374, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 471, - "name": "default.schema" - } - }, - { - "id": 376, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 473, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 377, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - }, - "inheritedFrom": { - "type": "reference", - "id": 474, - "name": "default.signal" - } - }, - { - "id": 372, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - }, - "inheritedFrom": { - "type": "reference", - "id": 469, - "name": "default.url" - } - }, - { - "id": 345, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 130, - "character": 2 - } - ], - "signatures": [ - { - "id": 346, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Set the AbortSignal for the fetch request." - }, - "parameters": [ - { - "id": 347, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" - }, - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 443, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 442, - "name": "default.abortSignal" - } - }, - { - "id": 207, - "name": "containedBy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 209, - "character": 2 - } - ], - "signatures": [ - { - "id": 208, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." - }, - "typeParameter": [ - { - "id": 209, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 210, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "reference", - "id": 209, - "name": "ColumnName" - } - }, - { - "id": 211, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 209, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 212, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." - }, - "parameters": [ - { - "id": 213, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 199, - "name": "contains", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 182, - "character": 2 - } - ], - "signatures": [ - { - "id": 200, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." - }, - "typeParameter": [ - { - "id": 201, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 202, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "reference", - "id": 201, - "name": "ColumnName" - } - }, - { - "id": 203, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 201, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 204, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." - }, - "parameters": [ - { - "id": 205, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The jsonb, array, or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 352, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 161, - "character": 2 - } - ], - "signatures": [ - { - "id": 353, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a string in CSV format." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 450, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 449, - "name": "default.csv" - } - }, - { - "id": 119, - "name": "eq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 33, - "character": 2 - } - ], - "signatures": [ - { - "id": 120, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "typeParameter": [ - { - "id": 121, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 122, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 121, - "name": "ColumnName" - } - }, - { - "id": 123, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 121, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 124, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "parameters": [ - { - "id": 125, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 126, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 356, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 195, - "character": 2 - } - ], - "signatures": [ - { - "id": 357, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query." - }, - "parameters": [ - { - "id": 358, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 363, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on buffer usage\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 365, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 208, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 362, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 361, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on WAL record generation\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 360, - 363, - 365, - 362, - 361, - 364 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "PostgrestResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 454, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 453, - "name": "default.explain" - } - }, - { - "id": 301, - "name": "filter", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 428, - "character": 2 - } - ], - "signatures": [ - { - "id": 302, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "typeParameter": [ - { - "id": 303, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 304, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 303, - "name": "ColumnName" - } - }, - { - "id": 305, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FilterOperator" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - } - ] - } - }, - { - "id": 306, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 307, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "parameters": [ - { - "id": 308, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to filter with, following PostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 310, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 354, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 2 - } - ], - "signatures": [ - { - "id": 355, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 452, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 451, - "name": "default.geojson" - } - }, - { - "id": 135, - "name": "gt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 61, - "character": 2 - } - ], - "signatures": [ - { - "id": 136, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than `value`." - }, - "typeParameter": [ - { - "id": 137, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 138, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 137, - "name": "ColumnName" - } - }, - { - "id": 139, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 137, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 140, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than `value`." - }, - "parameters": [ - { - "id": 141, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 142, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 143, - "name": "gte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 74, - "character": 2 - } - ], - "signatures": [ - { - "id": 144, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." - }, - "typeParameter": [ - { - "id": 145, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 146, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 145, - "name": "ColumnName" - } - }, - { - "id": 147, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 145, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 148, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is greater than or equal to `value`." - }, - "parameters": [ - { - "id": 149, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 150, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 175, - "name": "ilike", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 126, - "character": 2 - } - ], - "signatures": [ - { - "id": 176, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "typeParameter": [ - { - "id": 177, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 178, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 177, - "name": "ColumnName" - } - }, - { - "id": 179, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 180, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-insensitively." - }, - "parameters": [ - { - "id": 181, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 182, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 191, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 161, - "character": 2 - } - ], - "signatures": [ - { - "id": 192, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." - }, - "typeParameter": [ - { - "id": 193, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 194, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 193, - "name": "ColumnName" - } - }, - { - "id": 195, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values array to filter with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 193, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 196, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." - }, - "parameters": [ - { - "id": 197, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 198, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values array to filter with\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 183, - "name": "is", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 139, - "character": 2 - } - ], - "signatures": [ - { - "id": 184, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" - }, - "typeParameter": [ - { - "id": 185, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 186, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 185, - "name": "ColumnName" - } - }, - { - "id": 187, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 185, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 185, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - }, - { - "type": "literal", - "value": false - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 185, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - }, - { - "type": "literal", - "value": true - } - ] - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 188, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` IS `value`.", - "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" - }, - "parameters": [ - { - "id": 189, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 167, - "name": "like", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 113, - "character": 2 - } - ], - "signatures": [ - { - "id": 168, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." - }, - "typeParameter": [ - { - "id": 169, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 170, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 169, - "name": "ColumnName" - } - }, - { - "id": 171, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 172, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches `pattern` case-sensitively." - }, - "parameters": [ - { - "id": 173, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The pattern to match with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 332, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 2 - } - ], - "signatures": [ - { - "id": 333, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `count`." - }, - "parameters": [ - { - "id": 334, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The maximum number of rows to return" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 335, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 336, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 337, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 43 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 337 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 430, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 429, - "name": "default.limit" - } - }, - { - "id": 151, - "name": "lt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 87, - "character": 2 - } - ], - "signatures": [ - { - "id": 152, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than `value`." - }, - "typeParameter": [ - { - "id": 153, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 154, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 153, - "name": "ColumnName" - } - }, - { - "id": 155, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 153, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 156, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than `value`." - }, - "parameters": [ - { - "id": 157, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 158, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 159, - "name": "lte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 100, - "character": 2 - } - ], - "signatures": [ - { - "id": 160, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." - }, - "typeParameter": [ - { - "id": 161, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 162, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 161, - "name": "ColumnName" - } - }, - { - "id": 163, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 161, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 164, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is less than or equal to `value`." - }, - "parameters": [ - { - "id": 165, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 166, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 279, - "name": "match", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 369, - "character": 2 - } - ], - "signatures": [ - { - "id": 280, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." - }, - "typeParameter": [ - { - "id": 281, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 282, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 281, - "name": "ColumnName" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 281, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 283, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." - }, - "parameters": [ - { - "id": 284, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 350, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 152, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 535, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestMaybeSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 448, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 447, - "name": "default.maybeSingle" - } - }, - { - "id": 127, - "name": "neq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 128, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "typeParameter": [ - { - "id": 129, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 130, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 129, - "name": "ColumnName" - } - }, - { - "id": 131, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 129, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 132, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "parameters": [ - { - "id": 133, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 134, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 285, - "name": "not", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 385, - "character": 2 - } - ], - "signatures": [ - { - "id": 286, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "typeParameter": [ - { - "id": 287, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 288, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 287, - "name": "ColumnName" - } - }, - { - "id": 289, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" - }, - "type": { - "type": "reference", - "name": "FilterOperator" - } - }, - { - "id": 290, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 287, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 291, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.", - "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" - }, - "parameters": [ - { - "id": 292, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 293, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 294, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with, following PostgREST syntax\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 295, - "name": "or", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 422, - "character": 2 - } - ], - "signatures": [ - { - "id": 296, - "name": "or", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.", - "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" - }, - "parameters": [ - { - "id": 297, - "name": "filters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The filters to use, following PostgREST syntax" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 298, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 299, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 300, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 422, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 300 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 316, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 317, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "typeParameter": [ - { - "id": 318, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 319, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 318, - "name": "ColumnName" - } - }, - { - "id": 320, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 324, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 323, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 322, - 324, - 323 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 414, - "name": "default.order" - } - }, - { - "id": 325, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "parameters": [ - { - "id": 326, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 327, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 329, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 331, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 330, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 329, - 331, - 330 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 422, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 413, - "name": "default.order" - } - }, - { - "id": 255, - "name": "overlaps", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 308, - "character": 2 - } - ], - "signatures": [ - { - "id": 256, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." - }, - "typeParameter": [ - { - "id": 257, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range column to filter on" - }, - "type": { - "type": "reference", - "id": 257, - "name": "ColumnName" - } - }, - { - "id": 259, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 257, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 260, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." - }, - "parameters": [ - { - "id": 261, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The array or range value to filter with\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 338, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 2 - } - ], - "signatures": [ - { - "id": 339, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `from` and `to` inclusively." - }, - "parameters": [ - { - "id": 340, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 341, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 342, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 343, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 344, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 54 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 344 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 436, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 435, - "name": "default.range" - } - }, - { - "id": 247, - "name": "rangeAdjacent", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 293, - "character": 2 - } - ], - "signatures": [ - { - "id": 248, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." - }, - "typeParameter": [ - { - "id": 249, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 249, - "name": "ColumnName" - } - }, - { - "id": 251, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 252, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." - }, - "parameters": [ - { - "id": 253, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 254, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 215, - "name": "rangeGt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 235, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." - }, - "typeParameter": [ - { - "id": 217, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 218, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 217, - "name": "ColumnName" - } - }, - { - "id": 219, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 220, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." - }, - "parameters": [ - { - "id": 221, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 223, - "name": "rangeGte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 249, - "character": 2 - } - ], - "signatures": [ - { - "id": 224, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." - }, - "typeParameter": [ - { - "id": 225, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 225, - "name": "ColumnName" - } - }, - { - "id": 227, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 228, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." - }, - "parameters": [ - { - "id": 229, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 230, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 231, - "name": "rangeLt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 264, - "character": 2 - } - ], - "signatures": [ - { - "id": 232, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." - }, - "typeParameter": [ - { - "id": 233, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 233, - "name": "ColumnName" - } - }, - { - "id": 235, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 236, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." - }, - "parameters": [ - { - "id": 237, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 239, - "name": "rangeLte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 278, - "character": 2 - } - ], - "signatures": [ - { - "id": 240, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." - }, - "typeParameter": [ - { - "id": 241, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "reference", - "id": 241, - "name": "ColumnName" - } - }, - { - "id": 243, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 244, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." - }, - "parameters": [ - { - "id": 245, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 246, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The range to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 368, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 249, - "character": 2 - } - ], - "signatures": [ - { - "id": 369, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Override the type of the returned `data`." - }, - "typeParameter": [ - { - "id": 370, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new result type to override with\n" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 370, - "name": "NewResult" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 466, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 465, - "name": "default.returns" - } - }, - { - "id": 366, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 235, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" - }, - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 464, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 463, - "name": "default.rollback" - } - }, - { - "id": 311, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 24, - "character": 2 - } - ], - "signatures": [ - { - "id": 312, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" - }, - "typeParameter": [ - { - "id": 313, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 314, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 313, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 315, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 313, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 314, - "name": "NewResult" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 409, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 408, - "name": "default.select" - } - }, - { - "id": 348, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 141, - "character": 2 - } - ], - "signatures": [ - { - "id": 349, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 446, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 445, - "name": "default.single" - } - }, - { - "id": 263, - "name": "textSearch", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 331, - "character": 2 - } - ], - "signatures": [ - { - "id": 264, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, - "typeParameter": [ - { - "id": 265, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" - }, - "type": { - "type": "reference", - "id": 265, - "name": "ColumnName" - } - }, - { - "id": 267, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The query text to match with" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 268, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 270, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The text search configuration to use" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 334, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 271, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Change how the `query` text is interpreted\n" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 334, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 270, - 271 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 272, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." - }, - "parameters": [ - { - "id": 273, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The text or tsvector column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 274, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The query text to match with" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 275, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 276, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 277, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The text search configuration to use" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 339, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 278, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Change how the `query` text is interpreted\n" - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 339, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 277, - 278 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 386, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 387, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 388, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 389, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 390, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 392, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 393, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 394, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 396, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 397, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "default.then" - } - }, - { - "id": 384, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 385, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 113 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 383, - 375, - 378, - 373, - 371, - 374, - 376, - 377, - 372 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 345, - 207, - 199, - 352, - 119, - 356, - 301, - 354, - 135, - 143, - 175, - 191, - 183, - 167, - 332, - 151, - 159, - 279, - 350, - 127, - 285, - 295, - 316, - 255, - 338, - 247, - 215, - 223, - 231, - 239, - 368, - 366, - 311, - 348, - 263, - 386, - 384 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 398, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 399, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 400, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - ] - }, - { - "id": 49, - "name": "PostgrestQueryBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 50, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 16, - "character": 2 - } - ], - "signatures": [ - { - "id": 51, - "name": "new PostgrestQueryBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 53, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ], - "parameters": [ - { - "id": 54, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 55, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 59, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 60, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 61, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 62, - "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": 63, - "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": 57, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 58, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 59, - 57, - 58 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "reference", - "id": 53, - "name": "Relation" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 68, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 70, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 71, - "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": 72, - "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": 65, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 66, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 67, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - }, - { - "id": 64, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - }, - { - "id": 105, - "name": "delete", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 296, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "delete", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a DELETE on the table or view.", - "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" - }, - "parameters": [ - { - "id": 107, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 109, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 299, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 109 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 82, - "name": "insert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 117, - "character": 2 - } - ], - "signatures": [ - { - "id": 83, - "name": "insert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an INSERT into the table or view.", - "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 84, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 85, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 84, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 84, - "name": "Row" - } - } - ] - } - }, - { - "id": 86, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 122, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 88 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 73, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 55, - "character": 2 - } - ], - "signatures": [ - { - "id": 74, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT query on the table or view." - }, - "typeParameter": [ - { - "id": 75, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 76, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 75, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 77, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 75, - "name": "Query" - } - }, - { - "id": 78, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 79, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 80, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 81, - 80 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 76, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 98, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 247, - "character": 2 - } - ], - "signatures": [ - { - "id": 99, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an UPDATE on the table or view.", - "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" - }, - "typeParameter": [ - { - "id": 100, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 101, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to update with\n" - }, - "type": { - "type": "reference", - "id": 100, - "name": "Row" - } - }, - { - "id": 102, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 103, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 104, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 252, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 104 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 89, - "name": "upsert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 189, - "character": 2 - } - ], - "signatures": [ - { - "id": 90, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 91, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 92, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 91, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 91, - "name": "Row" - } - } - ] - } - }, - { - "id": 93, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 97, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 198, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 96, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 197, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 196, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 97, - 96, - 95 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 50 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 68, - 65, - 66, - 67, - 64 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 105, - 82, - 73, - 98, - 89 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 6, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 110, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 111, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ] - }, - { - "id": 401, - "name": "PostgrestTransformBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 402, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "signatures": [ - { - "id": 403, - "name": "new PostgrestTransformBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 404, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 405, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 406, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 407, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 500, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 499, - "name": "default.constructor" - } - }, - { - "id": 480, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 515, - "name": "default.allowEmpty" - } - }, - { - "id": 472, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 507, - "name": "default.body" - } - }, - { - "id": 475, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 477, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 478, - "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": 479, - "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" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 510, - "name": "default.fetch" - } - }, - { - "id": 470, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "inheritedFrom": { - "type": "reference", - "id": 505, - "name": "default.headers" - } - }, - { - "id": 468, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 503, - "name": "default.method" - } - }, - { - "id": 471, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 506, - "name": "default.schema" - } - }, - { - "id": 473, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 508, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 474, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - }, - "inheritedFrom": { - "type": "reference", - "id": 509, - "name": "default.signal" - } - }, - { - "id": 469, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - }, - "inheritedFrom": { - "type": "reference", - "id": 504, - "name": "default.url" - } - }, - { - "id": 442, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 130, - "character": 2 - } - ], - "signatures": [ - { - "id": 443, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Set the AbortSignal for the fetch request." - }, - "parameters": [ - { - "id": 444, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The AbortSignal to use for the fetch request\n" - }, - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 449, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 161, - "character": 2 - } - ], - "signatures": [ - { - "id": 450, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a string in CSV format." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - } - ] - }, - { - "id": 453, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 195, - "character": 2 - } - ], - "signatures": [ - { - "id": 454, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as the EXPLAIN plan for the query." - }, - "parameters": [ - { - "id": 455, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters\n" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 456, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 460, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on buffer usage\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 462, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 208, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 459, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 458, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 461, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, include information on WAL record generation\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 457, - 460, - 462, - 459, - 458, - 461 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "PostgrestResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - }, - { - "id": 451, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - } - ] - }, - { - "id": 429, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 2 - } - ], - "signatures": [ - { - "id": 430, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `count`." - }, - "parameters": [ - { - "id": 431, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The maximum number of rows to return" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 432, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 433, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 434, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 43 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 434 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 447, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 152, - "character": 2 - } - ], - "signatures": [ - { - "id": 448, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 535, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestMaybeSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - } - ] - }, - { - "id": 413, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 414, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "typeParameter": [ - { - "id": 415, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 416, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 318, - "name": "ColumnName" - } - }, - { - "id": 417, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 419, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 421, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 420, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 419, - 421, - 420 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 422, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Order the query result by `column`.", - "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" - }, - "parameters": [ - { - "id": 423, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 425, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 426, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, the result will be in ascending order" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 428, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Set this to order a foreign table by foreign\ncolumns\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 55, - "character": 37 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 426, - 428, - 427 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 435, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 2 - } - ], - "signatures": [ - { - "id": 436, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Limit the query result by `from` and `to` inclusively." - }, - "parameters": [ - { - "id": 437, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The starting index from which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 438, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The last index to which to limit the result" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 439, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "Named parameters" - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 441, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 54 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 441 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 465, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 249, - "character": 2 - } - ], - "signatures": [ - { - "id": 466, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Override the type of the returned `data`." - }, - "typeParameter": [ - { - "id": 467, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "shortText": "The new result type to override with\n" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 370, - "name": "NewResult" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 463, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 235, - "character": 2 - } - ], - "signatures": [ - { - "id": 464, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Rollback the query.", - "text": "`data` will still be returned, but the query is not committed.\n" - }, - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 408, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 24, - "character": 2 - } - ], - "signatures": [ - { - "id": 409, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a SELECT on the query result.", - "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" - }, - "typeParameter": [ - { - "id": 410, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 411, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 313, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 412, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The columns to retrieve, separated by commas\n" - }, - "type": { - "type": "reference", - "id": 313, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 314, - "name": "NewResult" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 445, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 141, - "character": 2 - } - ], - "signatures": [ - { - "id": 446, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Return `data` as a single object instead of an array of objects.", - "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - } - ] - }, - { - "id": 483, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2 - } - ], - "signatures": [ - { - "id": 484, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 485, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 486, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 487, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 488, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 489, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 490, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 491, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 492, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 493, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 494, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" - }, - "inheritedFrom": { - "type": "reference", - "id": 519, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 518, - "name": "default.then" - } - }, - { - "id": 481, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 482, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", - "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" - }, - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 517, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 516, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 402 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 480, - 472, - 475, - 470, - 468, - 471, - 473, - 474, - 469 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 442, - 449, - 453, - 451, - 429, - 447, - 413, - 435, - 465, - 463, - 408, - 445, - 483, - 481 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 10, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 495, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 496, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 497, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 112, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 537, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 542, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 541, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 542, - 540, - 541, - 539 - ] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29 - } - ] - } - } - }, - { - "id": 535, - "name": "PostgrestMaybeSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 45, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 536, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 536, - "name": "T" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 531, - "name": "PostgrestResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 35, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 532, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 532, - "name": "T" - } - ], - "name": "PostgrestResponseSuccess" - }, - { - "type": "reference", - "name": "PostgrestResponseFailure" - } - ] - } - }, - { - "id": 533, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 42, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 534, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 534, - "name": "T" - } - ], - "name": "PostgrestSingleResponseSuccess" - }, - { - "type": "reference", - "name": "PostgrestResponseFailure" - } - ] - } - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 498, - 1, - 112, - 49, - 401 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 537, - 535, - 531, - 533 - ] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] -} \ No newline at end of file + "id": 0, + "name": "@supabase/postgrest-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 498, + "name": "PostgrestBuilder", + "kind": 128, + "kindString": "Class", + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 499, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 2 + } + ], + "signatures": [ + { + "id": 500, + "name": "new PostgrestBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 501, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 502, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 515, + "name": "allowEmpty", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 507, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 510, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 511, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 512, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 513, + "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": 514, + "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": 505, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 503, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + } + }, + { + "id": 506, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 508, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 509, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + }, + { + "id": 504, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 518, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 519, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 520, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + }, + { + "id": 521, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 522, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 523, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 524, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 525, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 526, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 528, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 529, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "implementationOf": { + "type": "reference", + "name": "PromiseLike.then" + } + } + ], + "implementationOf": { + "type": "reference", + "name": "PromiseLike.then" + } + }, + { + "id": 516, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 517, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [499] + }, + { + "title": "Properties", + "kind": 1024, + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] + }, + { + "title": "Methods", + "kind": 2048, + "children": [518, 516] + } + ], + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 5, + "character": 30 + } + ], + "typeParameter": [ + { + "id": 530, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 401, + "name": "PostgrestTransformBuilder" + } + ], + "implementedTypes": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 501, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + }, + { + "id": 1, + "name": "PostgrestClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "PostgREST client." + }, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 41, + "character": 2 + } + ], + "signatures": [ + { + "id": 3, + "name": "new PostgrestClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Creates a PostgREST client." + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 6, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 7, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "URL of the PostgREST endpoint" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 9, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 12, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 50, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 13, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 14, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Custom fetch\n" + }, + "parameters": [ + { + "id": 15, + "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": 16, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 10, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Custom headers" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 48, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 11, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Postgres schema to switch to" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 49, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [12, 10, 11] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 1, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 6, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 20, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 21, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 22, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "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": 24, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 18, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 19, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + }, + { + "id": 17, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 25, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 59, + "character": 2 + } + ], + "signatures": [ + { + "id": 26, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 27, + "name": "TableName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 28, + "name": "Table", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericTable" + } + } + ], + "parameters": [ + { + "id": 29, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 27, + "name": "TableName" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "reference", + "id": 28, + "name": "Table" + } + ], + "name": "default" + } + }, + { + "id": 30, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "typeParameter": [ + { + "id": 31, + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 33, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "reference", + "id": 31, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "reference", + "id": 32, + "name": "View" + } + ], + "name": "default" + } + }, + { + "id": 34, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a query on a table or a view." + }, + "parameters": [ + { + "id": 35, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The table or view name to query\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 36, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 102, + "character": 2 + } + ], + "signatures": [ + { + "id": 37, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 38, + "name": "FunctionName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 39, + "name": "Function_", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericFunction" + } + } + ], + "parameters": [ + { + "id": 40, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call" + }, + "type": { + "type": "reference", + "id": 38, + "name": "FunctionName" + } + }, + { + "id": 41, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The arguments to pass to the function call" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Args" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + }, + "defaultValue": "{}" + }, + { + "id": 42, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 43, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 45, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 113, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 44, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." + }, + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 112, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [45, 44] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 6, + "name": "Schema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + } + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 39, + "name": "Function_" + } + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [2] + }, + { + "title": "Properties", + "kind": 1024, + "children": [20, 18, 19, 17] + }, + { + "title": "Methods", + "kind": 2048, + "children": [25, 36] + } + ], + "sources": [ + { + "fileName": "src/PostgrestClient.ts", + "line": 17, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 46, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + }, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 47, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 48, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ] + }, + { + "id": 112, + "name": "PostgrestFilterBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 113, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 114, + "name": "new PostgrestFilterBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 115, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 116, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 117, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 118, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 403, + "name": "default.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 402, + "name": "default.constructor" + } + }, + { + "id": 383, + "name": "allowEmpty", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 480, + "name": "default.allowEmpty" + } + }, + { + "id": 375, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "id": 472, + "name": "default.body" + } + }, + { + "id": 378, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 379, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 380, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 381, + "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": 382, + "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" + } + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 475, + "name": "default.fetch" + } + }, + { + "id": 373, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "inheritedFrom": { + "type": "reference", + "id": 470, + "name": "default.headers" + } + }, + { + "id": 371, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 468, + "name": "default.method" + } + }, + { + "id": 374, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 471, + "name": "default.schema" + } + }, + { + "id": 376, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 473, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 377, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + }, + "inheritedFrom": { + "type": "reference", + "id": 474, + "name": "default.signal" + } + }, + { + "id": 372, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + }, + "inheritedFrom": { + "type": "reference", + "id": 469, + "name": "default.url" + } + }, + { + "id": 345, + "name": "abortSignal", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 346, + "name": "abortSignal", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set the AbortSignal for the fetch request." + }, + "parameters": [ + { + "id": 347, + "name": "signal", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 443, + "name": "default.abortSignal" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 442, + "name": "default.abortSignal" + } + }, + { + "id": 207, + "name": "containedBy", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 209, + "character": 2 + } + ], + "signatures": [ + { + "id": 208, + "name": "containedBy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + }, + "typeParameter": [ + { + "id": 209, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 210, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "reference", + "id": 209, + "name": "ColumnName" + } + }, + { + "id": 211, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 209, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 212, + "name": "containedBy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." + }, + "parameters": [ + { + "id": 213, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 214, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 199, + "name": "contains", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 182, + "character": 2 + } + ], + "signatures": [ + { + "id": 200, + "name": "contains", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + }, + "typeParameter": [ + { + "id": 201, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 202, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "reference", + "id": 201, + "name": "ColumnName" + } + }, + { + "id": 203, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 201, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 204, + "name": "contains", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." + }, + "parameters": [ + { + "id": 205, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 206, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The jsonb, array, or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 352, + "name": "csv", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 161, + "character": 2 + } + ], + "signatures": [ + { + "id": 353, + "name": "csv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a string in CSV format." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 450, + "name": "default.csv" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 449, + "name": "default.csv" + } + }, + { + "id": 119, + "name": "eq", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 33, + "character": 2 + } + ], + "signatures": [ + { + "id": 120, + "name": "eq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + }, + "typeParameter": [ + { + "id": 121, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 122, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 121, + "name": "ColumnName" + } + }, + { + "id": 123, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 121, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 124, + "name": "eq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" + }, + "parameters": [ + { + "id": 125, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 126, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 356, + "name": "explain", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 195, + "character": 2 + } + ], + "signatures": [ + { + "id": 357, + "name": "explain", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as the EXPLAIN plan for the query." + }, + "parameters": [ + { + "id": 358, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 360, + "name": "analyze", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 203, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 363, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 206, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 365, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 208, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 362, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 205, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 361, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 204, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 364, + "name": "wal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 207, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [360, 363, 365, 362, 361, 364] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 454, + "name": "default.explain" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 453, + "name": "default.explain" + } + }, + { + "id": 301, + "name": "filter", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 428, + "character": 2 + } + ], + "signatures": [ + { + "id": 302, + "name": "filter", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "typeParameter": [ + { + "id": 303, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 304, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 303, + "name": "ColumnName" + } + }, + { + "id": 305, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to filter with, following PostgREST syntax" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "FilterOperator" + }, + { + "type": "literal", + "value": "not.eq" + }, + { + "type": "literal", + "value": "not.neq" + }, + { + "type": "literal", + "value": "not.gt" + }, + { + "type": "literal", + "value": "not.gte" + }, + { + "type": "literal", + "value": "not.lt" + }, + { + "type": "literal", + "value": "not.lte" + }, + { + "type": "literal", + "value": "not.like" + }, + { + "type": "literal", + "value": "not.ilike" + }, + { + "type": "literal", + "value": "not.is" + }, + { + "type": "literal", + "value": "not.in" + }, + { + "type": "literal", + "value": "not.cs" + }, + { + "type": "literal", + "value": "not.cd" + }, + { + "type": "literal", + "value": "not.sl" + }, + { + "type": "literal", + "value": "not.sr" + }, + { + "type": "literal", + "value": "not.nxl" + }, + { + "type": "literal", + "value": "not.nxr" + }, + { + "type": "literal", + "value": "not.adj" + }, + { + "type": "literal", + "value": "not.ov" + }, + { + "type": "literal", + "value": "not.fts" + }, + { + "type": "literal", + "value": "not.plfts" + }, + { + "type": "literal", + "value": "not.phfts" + }, + { + "type": "literal", + "value": "not.wfts" + } + ] + } + }, + { + "id": 306, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 307, + "name": "filter", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "parameters": [ + { + "id": 308, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to filter with, following PostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 310, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 354, + "name": "geojson", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 169, + "character": 2 + } + ], + "signatures": [ + { + "id": 355, + "name": "geojson", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 452, + "name": "default.geojson" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 451, + "name": "default.geojson" + } + }, + { + "id": 135, + "name": "gt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 136, + "name": "gt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than `value`." + }, + "typeParameter": [ + { + "id": 137, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 138, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 137, + "name": "ColumnName" + } + }, + { + "id": 139, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 137, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 140, + "name": "gt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than `value`." + }, + "parameters": [ + { + "id": 141, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 142, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 143, + "name": "gte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 74, + "character": 2 + } + ], + "signatures": [ + { + "id": 144, + "name": "gte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than or equal to `value`." + }, + "typeParameter": [ + { + "id": 145, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 146, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 145, + "name": "ColumnName" + } + }, + { + "id": 147, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 145, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 148, + "name": "gte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is greater than or equal to `value`." + }, + "parameters": [ + { + "id": 149, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 150, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 175, + "name": "ilike", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 126, + "character": 2 + } + ], + "signatures": [ + { + "id": 176, + "name": "ilike", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + }, + "typeParameter": [ + { + "id": 177, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 178, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 177, + "name": "ColumnName" + } + }, + { + "id": 179, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 180, + "name": "ilike", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." + }, + "parameters": [ + { + "id": 181, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 182, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 191, + "name": "in", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 161, + "character": 2 + } + ], + "signatures": [ + { + "id": 192, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "typeParameter": [ + { + "id": 193, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 194, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 193, + "name": "ColumnName" + } + }, + { + "id": 195, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values array to filter with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 193, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 196, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "parameters": [ + { + "id": 197, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 198, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values array to filter with\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 183, + "name": "is", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 139, + "character": 2 + } + ], + "signatures": [ + { + "id": 184, + "name": "is", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + }, + "typeParameter": [ + { + "id": 185, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 186, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 185, + "name": "ColumnName" + } + }, + { + "id": 187, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 185, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 185, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + }, + { + "type": "literal", + "value": false + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 185, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + }, + { + "type": "literal", + "value": true + } + ] + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 188, + "name": "is", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" + }, + "parameters": [ + { + "id": 189, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 190, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 167, + "name": "like", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 113, + "character": 2 + } + ], + "signatures": [ + { + "id": 168, + "name": "like", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + }, + "typeParameter": [ + { + "id": 169, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 170, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 169, + "name": "ColumnName" + } + }, + { + "id": 171, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 172, + "name": "like", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." + }, + "parameters": [ + { + "id": 173, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 174, + "name": "pattern", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The pattern to match with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 332, + "name": "limit", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 101, + "character": 2 + } + ], + "signatures": [ + { + "id": 333, + "name": "limit", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `count`." + }, + "parameters": [ + { + "id": 334, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The maximum number of rows to return" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 335, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 336, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 337, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 101, + "character": 43 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [337] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 430, + "name": "default.limit" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 429, + "name": "default.limit" + } + }, + { + "id": 151, + "name": "lt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 87, + "character": 2 + } + ], + "signatures": [ + { + "id": 152, + "name": "lt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than `value`." + }, + "typeParameter": [ + { + "id": 153, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 154, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 153, + "name": "ColumnName" + } + }, + { + "id": 155, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 153, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 156, + "name": "lt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than `value`." + }, + "parameters": [ + { + "id": 157, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 158, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 159, + "name": "lte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 100, + "character": 2 + } + ], + "signatures": [ + { + "id": 160, + "name": "lte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than or equal to `value`." + }, + "typeParameter": [ + { + "id": 161, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 162, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 161, + "name": "ColumnName" + } + }, + { + "id": 163, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 161, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 164, + "name": "lte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is less than or equal to `value`." + }, + "parameters": [ + { + "id": 165, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 166, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 279, + "name": "match", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 369, + "character": 2 + } + ], + "signatures": [ + { + "id": 280, + "name": "match", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + }, + "typeParameter": [ + { + "id": 281, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 282, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 281, + "name": "ColumnName" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 281, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 283, + "name": "match", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." + }, + "parameters": [ + { + "id": 284, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 350, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 152, + "character": 2 + } + ], + "signatures": [ + { + "id": 351, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 535, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "PostgrestMaybeSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 448, + "name": "default.maybeSingle" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 447, + "name": "default.maybeSingle" + } + }, + { + "id": 127, + "name": "neq", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 128, + "name": "neq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is not equal to `value`." + }, + "typeParameter": [ + { + "id": 129, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 130, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 129, + "name": "ColumnName" + } + }, + { + "id": 131, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 129, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 132, + "name": "neq", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is not equal to `value`." + }, + "parameters": [ + { + "id": 133, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 285, + "name": "not", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 385, + "character": 2 + } + ], + "signatures": [ + { + "id": 286, + "name": "not", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "typeParameter": [ + { + "id": 287, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 288, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 287, + "name": "ColumnName" + } + }, + { + "id": 289, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + }, + "type": { + "type": "reference", + "name": "FilterOperator" + } + }, + { + "id": 290, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 287, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 291, + "name": "not", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" + }, + "parameters": [ + { + "id": 292, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 293, + "name": "operator", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 294, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The value to filter with, following PostgREST syntax\n" + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 295, + "name": "or", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 422, + "character": 2 + } + ], + "signatures": [ + { + "id": 296, + "name": "or", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows which satisfy at least one of the filters.", + "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" + }, + "parameters": [ + { + "id": 297, + "name": "filters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The filters to use, following PostgREST syntax" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 298, + "name": "foreignTable", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 299, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 300, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 422, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [300] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 316, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 49, + "character": 2 + } + ], + "signatures": [ + { + "id": 317, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "typeParameter": [ + { + "id": 318, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 319, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 318, + "name": "ColumnName" + } + }, + { + "id": 320, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 321, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 322, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 324, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 323, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [322, 324, 323] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 414, + "name": "default.order" + } + }, + { + "id": 325, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "parameters": [ + { + "id": 326, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 327, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 328, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 329, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 331, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 330, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [329, 331, 330] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 422, + "name": "default.order" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 413, + "name": "default.order" + } + }, + { + "id": 255, + "name": "overlaps", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 308, + "character": 2 + } + ], + "signatures": [ + { + "id": 256, + "name": "overlaps", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + }, + "typeParameter": [ + { + "id": 257, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 258, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range column to filter on" + }, + "type": { + "type": "reference", + "id": 257, + "name": "ColumnName" + } + }, + { + "id": 259, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 257, + "name": "ColumnName" + }, + "objectType": { + "type": "reference", + "id": 116, + "name": "Row" + } + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 260, + "name": "overlaps", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." + }, + "parameters": [ + { + "id": 261, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 262, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The array or range value to filter with\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 338, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 116, + "character": 2 + } + ], + "signatures": [ + { + "id": 339, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `from` and `to` inclusively." + }, + "parameters": [ + { + "id": 340, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 341, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 342, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 343, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 344, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 116, + "character": 54 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [344] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 436, + "name": "default.range" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 435, + "name": "default.range" + } + }, + { + "id": 247, + "name": "rangeAdjacent", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 293, + "character": 2 + } + ], + "signatures": [ + { + "id": 248, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + }, + "typeParameter": [ + { + "id": 249, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 250, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 249, + "name": "ColumnName" + } + }, + { + "id": 251, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 252, + "name": "rangeAdjacent", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." + }, + "parameters": [ + { + "id": 253, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 254, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 215, + "name": "rangeGt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 235, + "character": 2 + } + ], + "signatures": [ + { + "id": 216, + "name": "rangeGt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + }, + "typeParameter": [ + { + "id": 217, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 218, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 217, + "name": "ColumnName" + } + }, + { + "id": 219, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 220, + "name": "rangeGt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." + }, + "parameters": [ + { + "id": 221, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 222, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 223, + "name": "rangeGte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 249, + "character": 2 + } + ], + "signatures": [ + { + "id": 224, + "name": "rangeGte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + }, + "typeParameter": [ + { + "id": 225, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 226, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 225, + "name": "ColumnName" + } + }, + { + "id": 227, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 228, + "name": "rangeGte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." + }, + "parameters": [ + { + "id": 229, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 230, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 231, + "name": "rangeLt", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 264, + "character": 2 + } + ], + "signatures": [ + { + "id": 232, + "name": "rangeLt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + }, + "typeParameter": [ + { + "id": 233, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 234, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 233, + "name": "ColumnName" + } + }, + { + "id": 235, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 236, + "name": "rangeLt", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." + }, + "parameters": [ + { + "id": 237, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 238, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 239, + "name": "rangeLte", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 278, + "character": 2 + } + ], + "signatures": [ + { + "id": 240, + "name": "rangeLte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + }, + "typeParameter": [ + { + "id": 241, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 242, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "reference", + "id": 241, + "name": "ColumnName" + } + }, + { + "id": 243, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 244, + "name": "rangeLte", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." + }, + "parameters": [ + { + "id": 245, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 246, + "name": "range", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The range to filter with\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 368, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 249, + "character": 2 + } + ], + "signatures": [ + { + "id": 369, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`." + }, + "typeParameter": [ + { + "id": 370, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with\n" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 370, + "name": "NewResult" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 466, + "name": "default.returns" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 465, + "name": "default.returns" + } + }, + { + "id": 366, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 235, + "character": 2 + } + ], + "signatures": [ + { + "id": 367, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 464, + "name": "default.rollback" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 463, + "name": "default.rollback" + } + }, + { + "id": 311, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 24, + "character": 2 + } + ], + "signatures": [ + { + "id": 312, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + }, + "typeParameter": [ + { + "id": 313, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 314, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 313, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 315, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas\n" + }, + "type": { + "type": "reference", + "id": 313, + "name": "Query" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 314, + "name": "NewResult" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 409, + "name": "default.select" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 408, + "name": "default.select" + } + }, + { + "id": 348, + "name": "single", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 141, + "character": 2 + } + ], + "signatures": [ + { + "id": 349, + "name": "single", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 446, + "name": "default.single" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 445, + "name": "default.single" + } + }, + { + "id": 263, + "name": "textSearch", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 331, + "character": 2 + } + ], + "signatures": [ + { + "id": 264, + "name": "textSearch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + }, + "typeParameter": [ + { + "id": 265, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 266, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The text or tsvector column to filter on" + }, + "type": { + "type": "reference", + "id": 265, + "name": "ColumnName" + } + }, + { + "id": 267, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The query text to match with" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 268, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 269, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 270, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The text search configuration to use" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 334, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 271, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 334, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [270, 271] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 272, + "name": "textSearch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." + }, + "parameters": [ + { + "id": 273, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The text or tsvector column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 274, + "name": "query", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The query text to match with" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 275, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 276, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 277, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The text search configuration to use" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 339, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 278, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 339, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "plain" + }, + { + "type": "literal", + "value": "phrase" + }, + { + "type": "literal", + "value": "websearch" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [277, 278] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 386, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 387, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 388, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + }, + { + "id": 389, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 390, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 391, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 392, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 393, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 394, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 395, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 396, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 397, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 484, + "name": "default.then" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 483, + "name": "default.then" + } + }, + { + "id": 384, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 385, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 482, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 481, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [113] + }, + { + "title": "Properties", + "kind": 1024, + "children": [383, 375, 378, 373, 371, 374, 376, 377, 372] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 345, 207, 199, 352, 119, 356, 301, 354, 135, 143, 175, 191, 183, 167, 332, 151, 159, + 279, 350, 127, 285, 295, 316, 255, 338, 247, 215, 223, 231, 239, 368, 366, 311, 348, + 263, 386, 384 + ] + } + ], + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 28, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 398, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 399, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 400, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 115, + "name": "Schema" + }, + { + "type": "reference", + "id": 116, + "name": "Row" + }, + { + "type": "reference", + "id": 117, + "name": "Result" + } + ], + "name": "default" + } + ] + }, + { + "id": 49, + "name": "PostgrestQueryBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 50, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 16, + "character": 2 + } + ], + "signatures": [ + { + "id": 51, + "name": "new PostgrestQueryBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 52, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 53, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + } + ], + "parameters": [ + { + "id": 54, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 55, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 56, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 59, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 60, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 61, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 62, + "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": 63, + "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": 57, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 23, + "character": 6 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 58, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 24, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [59, 57, 58] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "reference", + "id": 53, + "name": "Relation" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 68, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 69, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 70, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 71, + "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": 72, + "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": 65, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 66, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 12, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 67, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 13, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + }, + { + "id": 64, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 10, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + }, + { + "id": 105, + "name": "delete", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 296, + "character": 2 + } + ], + "signatures": [ + { + "id": 106, + "name": "delete", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a DELETE on the table or view.", + "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + }, + "parameters": [ + { + "id": 107, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 108, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 109, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 299, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [109] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "intrinsic", + "name": "undefined" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 82, + "name": "insert", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 117, + "character": 2 + } + ], + "signatures": [ + { + "id": 83, + "name": "insert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an INSERT into the table or view.", + "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 84, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 85, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 84, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 84, + "name": "Row" + } + } + ] + } + }, + { + "id": 86, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 87, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 88, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 122, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [88] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "intrinsic", + "name": "undefined" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 73, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 55, + "character": 2 + } + ], + "signatures": [ + { + "id": 74, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT query on the table or view." + }, + "typeParameter": [ + { + "id": 75, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 76, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "reference", + "id": 75, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 77, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas\n" + }, + "type": { + "type": "reference", + "id": 75, + "name": "Query" + } + }, + { + "id": 78, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 79, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 81, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 62, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 80, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 61, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [81, 80] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "reference", + "id": 76, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 98, + "name": "update", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 247, + "character": 2 + } + ], + "signatures": [ + { + "id": 99, + "name": "update", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an UPDATE on the table or view.", + "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" + }, + "typeParameter": [ + { + "id": 100, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 101, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to update with\n" + }, + "type": { + "type": "reference", + "id": 100, + "name": "Row" + } + }, + { + "id": 102, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 103, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 104, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 252, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [104] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "intrinsic", + "name": "undefined" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 89, + "name": "upsert", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 189, + "character": 2 + } + ], + "signatures": [ + { + "id": 90, + "name": "upsert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 91, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 92, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 91, + "name": "Row" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 91, + "name": "Row" + } + } + ] + } + }, + { + "id": 93, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 97, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 198, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 96, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 197, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 95, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 196, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [97, 96, 95] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 112, + "typeArguments": [ + { + "type": "reference", + "id": 52, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 53, + "name": "Relation" + } + }, + { + "type": "intrinsic", + "name": "undefined" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [50] + }, + { + "title": "Properties", + "kind": 1024, + "children": [68, 65, 66, 67, 64] + }, + { + "title": "Methods", + "kind": 2048, + "children": [105, 82, 73, 98, 89] + } + ], + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 6, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 110, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 111, + "name": "Relation", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] + } + } + ] + }, + { + "id": 401, + "name": "PostgrestTransformBuilder", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 402, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "signatures": [ + { + "id": 403, + "name": "new PostgrestTransformBuilder", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "typeParameter": [ + { + "id": 404, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 405, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 406, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "parameters": [ + { + "id": 407, + "name": "builder", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 500, + "name": "default.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 499, + "name": "default.constructor" + } + }, + { + "id": 480, + "name": "allowEmpty", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 515, + "name": "default.allowEmpty" + } + }, + { + "id": 472, + "name": "body", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 12, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "id": 507, + "name": "default.body" + } + }, + { + "id": 475, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 15, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 476, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 477, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 478, + "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": 479, + "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" + } + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 510, + "name": "default.fetch" + } + }, + { + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "inheritedFrom": { + "type": "reference", + "id": 505, + "name": "default.headers" + } + }, + { + "id": 468, + "name": "method", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 503, + "name": "default.method" + } + }, + { + "id": 471, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 11, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 506, + "name": "default.schema" + } + }, + { + "id": 473, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 508, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 474, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + }, + "inheritedFrom": { + "type": "reference", + "id": 509, + "name": "default.signal" + } + }, + { + "id": 469, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + }, + "inheritedFrom": { + "type": "reference", + "id": 504, + "name": "default.url" + } + }, + { + "id": 442, + "name": "abortSignal", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 443, + "name": "abortSignal", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set the AbortSignal for the fetch request." + }, + "parameters": [ + { + "id": 444, + "name": "signal", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 449, + "name": "csv", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 161, + "character": 2 + } + ], + "signatures": [ + { + "id": 450, + "name": "csv", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a string in CSV format." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + } + ] + }, + { + "id": 453, + "name": "explain", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 195, + "character": 2 + } + ], + "signatures": [ + { + "id": 454, + "name": "explain", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as the EXPLAIN plan for the query." + }, + "parameters": [ + { + "id": 455, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 456, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 457, + "name": "analyze", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 203, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 460, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 206, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 462, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 208, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 459, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 205, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 458, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 204, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 461, + "name": "wal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 207, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [457, 460, 462, 459, 458, 461] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + }, + { + "id": 451, + "name": "geojson", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 169, + "character": 2 + } + ], + "signatures": [ + { + "id": 452, + "name": "geojson", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + } + ] + }, + { + "id": 429, + "name": "limit", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 101, + "character": 2 + } + ], + "signatures": [ + { + "id": 430, + "name": "limit", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `count`." + }, + "parameters": [ + { + "id": 431, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The maximum number of rows to return" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 432, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 433, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 434, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 101, + "character": 43 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [434] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 447, + "name": "maybeSingle", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 152, + "character": 2 + } + ], + "signatures": [ + { + "id": 448, + "name": "maybeSingle", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 535, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "PostgrestMaybeSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + } + ] + }, + { + "id": 413, + "name": "order", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 49, + "character": 2 + } + ], + "signatures": [ + { + "id": 414, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "typeParameter": [ + { + "id": 415, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 416, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 318, + "name": "ColumnName" + } + }, + { + "id": 417, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 419, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 421, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "undefined" + } + }, + { + "id": 420, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 51, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [419, 421, 420] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + }, + { + "id": 422, + "name": "order", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" + }, + "parameters": [ + { + "id": 423, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 424, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 425, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 426, + "name": "ascending", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 428, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "nullsFirst", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 55, + "character": 37 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [426, 428, 427] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 435, + "name": "range", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 116, + "character": 2 + } + ], + "signatures": [ + { + "id": 436, + "name": "range", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Limit the query result by `from` and `to` inclusively." + }, + "parameters": [ + { + "id": 437, + "name": "from", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 438, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 439, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", + "type": { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 441, + "name": "foreignTable", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 116, + "character": 54 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [441] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 465, + "name": "returns", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 249, + "character": 2 + } + ], + "signatures": [ + { + "id": 466, + "name": "returns", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Override the type of the returned `data`." + }, + "typeParameter": [ + { + "id": 467, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The new result type to override with\n" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 370, + "name": "NewResult" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 463, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 235, + "character": 2 + } + ], + "signatures": [ + { + "id": 464, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 408, + "name": "select", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 24, + "character": 2 + } + ], + "signatures": [ + { + "id": 409, + "name": "select", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" + }, + "typeParameter": [ + { + "id": 410, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "literal", + "value": "*" + } + }, + { + "id": 411, + "name": "NewResult", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 313, + "name": "Query" + } + ], + "name": "GetResult" + } + } + ], + "parameters": [ + { + "id": 412, + "name": "columns", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The columns to retrieve, separated by commas\n" + }, + "type": { + "type": "reference", + "id": 313, + "name": "Query" + } + } + ], + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 314, + "name": "NewResult" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 445, + "name": "single", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 141, + "character": 2 + } + ], + "signatures": [ + { + "id": 446, + "name": "single", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + } + ] + }, + { + "id": 483, + "name": "then", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 48, + "character": 2 + } + ], + "signatures": [ + { + "id": 484, + "name": "then", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 485, + "name": "TResult1", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + }, + { + "id": 486, + "name": "TResult2", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "never" + } + } + ], + "parameters": [ + { + "id": 487, + "name": "onfulfilled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 488, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 489, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 490, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 531, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "PostgrestResponse" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 491, + "name": "onrejected", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 492, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 493, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 494, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + } + ] + } + } + ] + } + } + ] + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 388, + "name": "TResult1" + }, + { + "type": "reference", + "id": 389, + "name": "TResult2" + } + ] + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + "inheritedFrom": { + "type": "reference", + "id": 519, + "name": "default.then" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 518, + "name": "default.then" + } + }, + { + "id": 481, + "name": "throwOnError", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 482, + "name": "throwOnError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", + "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" + }, + "type": { + "type": "reference", + "id": 401, + "typeArguments": [ + { + "type": "reference", + "id": 404, + "name": "Schema" + }, + { + "type": "reference", + "id": 405, + "name": "Row" + }, + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 517, + "name": "default.throwOnError" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 516, + "name": "default.throwOnError" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [402] + }, + { + "title": "Properties", + "kind": 1024, + "children": [480, 472, 475, 470, 468, 471, 473, 474, 469] + }, + { + "title": "Methods", + "kind": 2048, + "children": [442, 449, 453, 451, 429, 447, 413, 435, 465, 463, 408, 445, 483, 481] + } + ], + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 10, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 495, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 496, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 497, + "name": "Result", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 498, + "typeArguments": [ + { + "type": "reference", + "id": 406, + "name": "Result" + } + ], + "name": "default" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 112, + "name": "PostgrestFilterBuilder" + } + ] + }, + { + "id": 537, + "name": "PostgrestError", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "Error format", + "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + }, + "sources": [ + { + "fileName": "src/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 538, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 542, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 12, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 540, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 10, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 541, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 539, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [542, 540, 541, 539] + } + ], + "sources": [ + { + "fileName": "src/types.ts", + "line": 8, + "character": 29 + } + ] + } + } + }, + { + "id": 535, + "name": "PostgrestMaybeSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 45, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 536, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reference", + "id": 533, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "id": 536, + "name": "T" + }, + { + "type": "literal", + "value": null + } + ] + } + ], + "name": "PostgrestSingleResponse" + } + }, + { + "id": 531, + "name": "PostgrestResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 35, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 532, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 532, + "name": "T" + } + ], + "name": "PostgrestResponseSuccess" + }, + { + "type": "reference", + "name": "PostgrestResponseFailure" + } + ] + } + }, + { + "id": 533, + "name": "PostgrestSingleResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/types.ts", + "line": 42, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 534, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 534, + "name": "T" + } + ], + "name": "PostgrestSingleResponseSuccess" + }, + { + "type": "reference", + "name": "PostgrestResponseFailure" + } + ] + } + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [498, 1, 112, 49, 401] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [537, 535, 531, 533] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] +} diff --git a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index 4e601e2c9e3..19da10fd6b8 100644 --- a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -75,32 +75,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -744,32 +729,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -1150,11 +1120,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 12, - 10, - 11 - ] + "children": [12, 10, 11] } ] } @@ -1712,10 +1678,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 45, - 44 - ] + "children": [45, 44] } ] } @@ -1833,27 +1796,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 2 - ] + "children": [2] }, { "title": "Properties", "kind": 1024, - "children": [ - 20, - 18, - 19, - 17 - ] + "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, - "children": [ - 25, - 36 - ] + "children": [25, 36] } ], "sources": [ @@ -2727,32 +2680,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -4107,14 +4045,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 360, - 363, - 365, - 362, - 361, - 364 - ] + "children": [360, 363, 365, 362, 361, 364] } ] } @@ -5661,9 +5592,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 337 - ] + "children": [337] } ] } @@ -6691,9 +6620,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 300 - ] + "children": [300] } ] } @@ -6874,11 +6801,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322, - 324, - 323 - ] + "children": [322, 324, 323] } ] } @@ -7030,11 +6953,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 329, - 331, - 330 - ] + "children": [329, 331, 330] } ] } @@ -7363,9 +7282,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 344 - ] + "children": [344] } ] } @@ -8644,10 +8561,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 270, - 271 - ] + "children": [270, 271] } ] } @@ -8799,10 +8713,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 277, - 278 - ] + "children": [277, 278] } ] } @@ -9142,66 +9053,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 113 - ] + "children": [113] }, { "title": "Properties", "kind": 1024, - "children": [ - 383, - 375, - 378, - 373, - 371, - 374, - 376, - 377, - 372 - ] + "children": [383, 375, 378, 373, 371, 374, 376, 377, 372] }, { "title": "Methods", "kind": 2048, "children": [ - 345, - 207, - 199, - 352, - 119, - 356, - 301, - 354, - 135, - 143, - 175, - 191, - 183, - 167, - 332, - 151, - 159, - 279, - 350, - 127, - 285, - 295, - 316, - 255, - 338, - 247, - 215, - 223, - 231, - 239, - 368, - 366, - 311, - 348, - 263, - 386, - 384 + 345, 207, 199, 352, 119, 356, 301, 354, 135, 143, 175, 191, 183, 167, 332, 151, 159, + 279, 350, 127, 285, 295, 316, 255, 338, 247, 215, 223, 231, 239, 368, 366, 311, 348, + 263, 386, 384 ] } ], @@ -9516,11 +9381,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 59, - 57, - 58 - ] + "children": [59, 57, 58] } ] } @@ -9814,9 +9675,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 109 - ] + "children": [109] } ] } @@ -9993,9 +9852,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 88 - ] + "children": [88] } ] } @@ -10211,10 +10068,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 80 - ] + "children": [81, 80] } ] } @@ -10380,9 +10234,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 104 - ] + "children": [104] } ] } @@ -10605,11 +10457,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 97, - 96, - 95 - ] + "children": [97, 96, 95] } ] } @@ -10653,31 +10501,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 50 - ] + "children": [50] }, { "title": "Properties", "kind": 1024, - "children": [ - 68, - 65, - 66, - 67, - 64 - ] + "children": [68, 65, 66, 67, 64] }, { "title": "Methods", "kind": 2048, - "children": [ - 105, - 82, - 73, - 98, - 89 - ] + "children": [105, 82, 73, 98, 89] } ], "sources": [ @@ -11454,32 +11288,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 499 - ] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [ - 515, - 507, - 510, - 505, - 503, - 506, - 508, - 509, - 504 - ] + "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] }, { "title": "Methods", "kind": 2048, - "children": [ - 518, - 516 - ] + "children": [518, 516] } ], "sources": [ @@ -12208,14 +12027,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 457, - 460, - 462, - 459, - 458, - 461 - ] + "children": [457, 460, 462, 459, 458, 461] } ] } @@ -12423,9 +12235,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 434 - ] + "children": [434] } ] } @@ -12653,11 +12463,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 419, - 421, - 420 - ] + "children": [419, 421, 420] } ] } @@ -12804,11 +12610,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 426, - 428, - 427 - ] + "children": [426, 428, 427] } ] } @@ -12939,9 +12741,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 441 - ] + "children": [441] } ] } @@ -13552,44 +13352,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 402 - ] + "children": [402] }, { "title": "Properties", "kind": 1024, - "children": [ - 480, - 472, - 475, - 470, - 468, - 471, - 473, - 474, - 469 - ] + "children": [480, 472, 475, 470, 468, 471, 473, 474, 469] }, { "title": "Methods", "kind": 2048, - "children": [ - 442, - 449, - 453, - 451, - 429, - 447, - 413, - 435, - 465, - 463, - 408, - 445, - 483, - 481 - ] + "children": [442, 449, 453, 451, 429, 447, 413, 435, 465, 463, 408, 445, 483, 481] } ], "sources": [ @@ -13767,12 +13540,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 542, - 540, - 541, - 539 - ] + "children": [542, 540, 541, 539] } ], "sources": [ @@ -13853,10 +13621,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } }, { @@ -13883,10 +13648,7 @@ ], "type": { "type": "union", - "types": [ - null, - null - ] + "types": [null, null] } } ], @@ -13894,23 +13656,12 @@ { "title": "Classes", "kind": 128, - "children": [ - 498, - 1, - 112, - 49, - 401 - ] + "children": [498, 1, 112, 49, 401] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 537, - 535, - 531, - 533 - ] + "children": [537, 535, 531, 533] } ], "sources": [ @@ -13920,4 +13671,4 @@ "character": 0 } ] -} \ No newline at end of file +} diff --git a/spec/enrichments/tsdoc_v2/realtime.json b/spec/enrichments/tsdoc_v2/realtime.json index b0b5214aef6..79913e6a85a 100644 --- a/spec/enrichments/tsdoc_v2/realtime.json +++ b/spec/enrichments/tsdoc_v2/realtime.json @@ -1,6075 +1,5888 @@ { - "id": 0, - "name": "@supabase/realtime-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 500, - "name": "REALTIME_LISTEN_TYPES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 501, - "name": "BROADCAST", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" - }, - { - "id": 503, - "name": "POSTGRES_CHANGES", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" - }, - { - "id": 502, - "name": "PRESENCE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 78, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [ - 501, - 503, - 502 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 76, - "character": 12 - } - ] - }, - { - "id": 504, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 505, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 70, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 508, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" - }, - { - "id": 506, - "name": "INSERT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" - }, - { - "id": 507, - "name": "UPDATE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [ - 505, - 508, - 506, - 507 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 69, - "character": 12 - } - ] - }, - { - "id": 509, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 511, - "name": "JOIN", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "join" - }, - "defaultValue": "\"join\"" - }, - { - "id": 512, - "name": "LEAVE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "leave" - }, - "defaultValue": "\"leave\"" - }, - { - "id": 510, - "name": "SYNC", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "sync" - }, - "defaultValue": "\"sync\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [ - 511, - 512, - 510 - ] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 34, - "character": 12 - } - ] - }, - { - "id": 513, - "name": "REALTIME_SUBSCRIBE_STATES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 517, - "name": "CHANNEL_ERROR", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 516, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 514, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" - }, - { - "id": 515, - "name": "TIMED_OUT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [ - 517, - 516, - 514, - 515 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 82, - "character": 12 - } - ] - }, - { - "id": 55, - "name": "RealtimeChannel", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." - }, - "children": [ - { - "id": 66, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 111, - "character": 2 - } - ], - "signatures": [ - { - "id": 67, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 68, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 69, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 70, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 71, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 72, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 73, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 74, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 75, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 77, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 98, - "character": 14 - } - ], - "indexSignature": { - "id": 79, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 80, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 82, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 76, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 96, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 86, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 85, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 91, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 89, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 109, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 88, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 87, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 107, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 92, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - }, - { - "id": 84, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 83, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 90, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 119, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 120, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Listen to messages." - }, - "parameters": [ - { - "id": 121, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 122, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 124, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 317, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 124 - ] - } - ] - } - } - }, - { - "id": 125, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 126, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 127, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 128, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 131, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 320, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 130, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 319, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 131, - 130 - ] - } - ], - "indexSignature": { - "id": 132, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 133, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 134, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 136, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 326, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 138 - ] - } - ] - } - } - }, - { - "id": 139, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 141, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 142, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 143, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 144, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 146, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 331, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 146 - ] - } - ] - } - } - }, - { - "id": 147, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 148, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 149, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 150, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 483, - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 151, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 152, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 153, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 155, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 336, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 155 - ] - } - ] - } - } - }, - { - "id": 156, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 158, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 159, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 489, - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 160, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 164, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 162, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 163, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 165, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 166, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 442, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 167, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 169, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 170, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 449, - "typeArguments": [ - { - "type": "reference", - "id": 164, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 171, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 175, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 173, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 174, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 176, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 177, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 442, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 178, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 179, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 180, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 454, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 182, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 186, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 184, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 185, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 187, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 188, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 442, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 189, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 191, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 192, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 193, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 197, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 195, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 196, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 198, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 199, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 442, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "id": 200, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 202, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 203, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 473, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 101, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 284, - "character": 2 - } - ], - "signatures": [ - { - "id": 102, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "id": 495, - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 204, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 367, - "character": 2 - } - ], - "signatures": [ - { - "id": 205, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 206, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 368, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 208 - ] - } - ], - "indexSignature": { - "id": 209, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 210, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 211, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 213, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 93, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 171, - "character": 2 - } - ], - "signatures": [ - { - "id": 94, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 95, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 97, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 98, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "SUBSCRIBED" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "CLOSED" - }, - { - "type": "literal", - "value": "CHANNEL_ERROR" - } - ] - } - }, - { - "id": 99, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 100, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 103, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 288, - "character": 8 - } - ], - "signatures": [ - { - "id": 104, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 105, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 107, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 108, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 109, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 111, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 112, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 221, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 407, - "character": 2 - } - ], - "signatures": [ - { - "id": 222, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Leaves the channel.", - "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" - }, - "parameters": [ - { - "id": 223, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "error" - }, - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 113, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 302, - "character": 8 - } - ], - "signatures": [ - { - "id": 114, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 115, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 116, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 117, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 118, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 215, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 394, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 217, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 219, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 220, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 66 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 94, - "character": 21 - } - ] - }, - { - "id": 306, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 307, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "signatures": [ - { - "id": 308, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 309, - "name": "endPoint", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 310, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 418, - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - } - ] - }, - { - "id": 311, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 312, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 333, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 331, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 55, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 330, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 313, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 342, - "name": "eventsPerSecondLimitMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 314, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 315, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 316, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 317, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 324, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 325, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timer", - "package": "@types/node", - "name": "Timer" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 343, - "name": "inThrottle", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 329, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 53, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 318, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 320, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 321, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 326, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 332, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 328, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 327, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 334, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 335, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 336, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 60, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 339, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 340, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 341, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 338, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 322, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 323, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "w3cwebsocket" - }, - { - "id": 366, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 218, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 368, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 369, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 344, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 125, - "character": 2 - } - ], - "signatures": [ - { - "id": 345, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 362, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 198, - "character": 2 - } - ], - "signatures": [ - { - "id": 363, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 346, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 347, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 348, - "name": "code", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A numeric status code to send on disconnect." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 349, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom reason for the disconnect.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 350, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 162, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 55, - "name": "default" - } - } - } - ] - }, - { - "id": 364, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 214, - "character": 2 - } - ], - "signatures": [ - { - "id": 365, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 357, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 191, - "character": 2 - } - ], - "signatures": [ - { - "id": 358, - "name": "log", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs the message.", - "text": "For customized logging, `this.logger` can be overridden.\n" - }, - "parameters": [ - { - "id": 359, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 370, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 236, - "character": 2 - } - ], - "signatures": [ - { - "id": 371, - "name": "push", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Push out a message if the socket is connected.", - "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" - }, - "parameters": [ - { - "id": 372, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 435, - "name": "RealtimeMessage" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - } - ] - }, - { - "id": 355, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 177, - "character": 2 - } - ], - "signatures": [ - { - "id": 356, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 499, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 352, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 166, - "character": 2 - } - ], - "signatures": [ - { - "id": 353, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 354, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 499, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 373, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 263, - "character": 2 - } - ], - "signatures": [ - { - "id": 374, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." - }, - "parameters": [ - { - "id": 375, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 307 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 40, - "character": 21 - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 28, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 29, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 30, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 31, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" - }, - "type": { - "type": "reference", - "qualifiedName": "PresenceOpts", - "package": "@types/phoenix", - "name": "PresenceOpts" - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 35, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 36, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 38, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 39, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "signatures": [ - { - "id": 40, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 37, - 38 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 39 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 41, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 34, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 33, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 32, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 495, - "name": "RealtimePresenceState" - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 28 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 35, - 41, - 34, - 33, - 32 - ] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 62, - "character": 21 - } - ] - }, - { - "id": 294, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 296, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 297, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 298, - "name": "broadcast", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 299, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 301, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 300, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 301, - 300 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 16 - } - ] - } - } - }, - { - "id": 302, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 303, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 304, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 304 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 15 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 298, - 302 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 14, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 296 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 13, - "character": 37 - } - ] - } - } - }, - { - "id": 305, - "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - }, - { - "id": 418, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 419, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 425, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 424, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 427, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 428, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 24, - "character": 12 - } - ], - "indexSignature": { - "id": 429, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 430, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 422, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 423, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 431, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 11 - } - ], - "indexSignature": { - "id": 433, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 434, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 426, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 421, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 420, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 16, - "character": 36 - } - ] - } - } - }, - { - "id": 435, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 438, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 439, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 440, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 28, - "character": 30 - } - ] - } - } - }, - { - "id": 442, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 60, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 448, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 443, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 444, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 448, - "name": "T" - } - }, - { - "id": 447, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 60, - "character": 62 - } - ] - } - } - }, - { - "id": 449, - "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 55, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 453, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 450, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 55, - "character": 53 - } - ], - "indexSignature": { - "id": 451, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 454, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "reference", - "id": 473, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - ] - } - }, - { - "id": 473, - "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 48, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 482, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 479, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 48, - "character": 52 - } - ], - "indexSignature": { - "id": 480, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 481, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 508, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 476, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 477, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 51, - "character": 9 - } - ] - } - } - }, - { - "id": 478, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 482, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 475, - 476, - 478 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 49, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 454, - "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 34, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 463, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 34, - "character": 52 - } - ], - "indexSignature": { - "id": 461, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 462, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 456, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 36, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 506, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "" - ] - ] - } - }, - { - "id": 457, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 463, - "name": "T" - } - }, - { - "id": 458, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 38, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 456, - 457, - 458 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 35, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 464, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 41, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 472, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 469, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 41, - "character": 52 - } - ], - "indexSignature": { - "id": 470, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 471, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "name": "RealtimePostgresChangesPayloadBase" - }, - { - "type": "reflection", - "declaration": { - "id": 465, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 466, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 507, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" - ] - ] - } - }, - { - "id": 467, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 472, - "name": "T" - } - }, - { - "id": 468, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 472, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 466, - 467, - 468 - ] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 42, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 483, - "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 20, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 484, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 487, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - }, - { - "id": 485, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 511, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 486, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 487, - 485, - 486, - 488 - ] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 20, - "character": 42 - } - ] - } - } - }, - { - "id": 489, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 27, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 490, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 493, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - }, - { - "id": 491, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 512, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 492, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 493, - 491, - 492, - 494 - ] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 27, - "character": 43 - } - ] - } - } - }, - { - "id": 495, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 18, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 18, - "character": 36 - } - ], - "indexSignature": { - "id": 497, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 498, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - } - } - }, - { - "id": 499, - "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 36, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "kind": 8, - "children": [ - 500, - 504, - 509, - 513 - ] - }, - { - "title": "Classes", - "kind": 128, - "children": [ - 55, - 306, - 1 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 294, - 305, - 418, - 435, - 442, - 449, - 473, - 454, - 464, - 483, - 489, - 495, - 499 - ] - } - ], - "sources": [ - { - "fileName": "index.ts", - "line": 1, - "character": 0 - } - ] -} \ No newline at end of file + "id": 0, + "name": "@supabase/realtime-js", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", + "children": [ + { + "id": 500, + "name": "REALTIME_LISTEN_TYPES", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 501, + "name": "BROADCAST", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 77, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "broadcast" + }, + "defaultValue": "\"broadcast\"" + }, + { + "id": 503, + "name": "POSTGRES_CHANGES", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 79, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "postgres_changes" + }, + "defaultValue": "\"postgres_changes\"" + }, + { + "id": 502, + "name": "PRESENCE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 78, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "presence" + }, + "defaultValue": "\"presence\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [501, 503, 502] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 76, + "character": 12 + } + ] + }, + { + "id": 504, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 505, + "name": "ALL", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 70, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "*" + }, + "defaultValue": "\"*\"" + }, + { + "id": 508, + "name": "DELETE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "DELETE" + }, + "defaultValue": "\"DELETE\"" + }, + { + "id": 506, + "name": "INSERT", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "INSERT" + }, + "defaultValue": "\"INSERT\"" + }, + { + "id": 507, + "name": "UPDATE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "UPDATE" + }, + "defaultValue": "\"UPDATE\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [505, 508, 506, 507] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 69, + "character": 12 + } + ] + }, + { + "id": 509, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 511, + "name": "JOIN", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "join" + }, + "defaultValue": "\"join\"" + }, + { + "id": 512, + "name": "LEAVE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "leave" + }, + "defaultValue": "\"leave\"" + }, + { + "id": 510, + "name": "SYNC", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "sync" + }, + "defaultValue": "\"sync\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [511, 512, 510] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 34, + "character": 12 + } + ] + }, + { + "id": 513, + "name": "REALTIME_SUBSCRIBE_STATES", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 517, + "name": "CHANNEL_ERROR", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + }, + "defaultValue": "\"CHANNEL_ERROR\"" + }, + { + "id": 516, + "name": "CLOSED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + }, + "defaultValue": "\"CLOSED\"" + }, + { + "id": 514, + "name": "SUBSCRIBED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 83, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "SUBSCRIBED" + }, + "defaultValue": "\"SUBSCRIBED\"" + }, + { + "id": 515, + "name": "TIMED_OUT", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "TIMED_OUT" + }, + "defaultValue": "\"TIMED_OUT\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [517, 516, 514, 515] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 82, + "character": 12 + } + ] + }, + { + "id": 55, + "name": "RealtimeChannel", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "A channel is the basic building block of Realtime\nand narrows the scope of data flow to subscribed clients.\nYou can think of a channel as a chatroom where participants are able to see who's online\nand send and receive messages." + }, + "children": [ + { + "id": 66, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 111, + "character": 2 + } + ], + "signatures": [ + { + "id": 67, + "name": "new RealtimeChannel", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 68, + "name": "topic", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 69, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 294, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + }, + { + "id": 70, + "name": "socket", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 306, + "name": "default" + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + } + ] + }, + { + "id": 71, + "name": "bindings", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 95, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 72, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 73, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 74, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 75, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 81, + "name": "callback", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 77, + "name": "filter", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 98, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 78, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 98, + "character": 14 + } + ], + "indexSignature": { + "id": 79, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 80, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 82, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 100, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 76, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 97, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [81, 77, 82, 76] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 96, + "character": 19 + } + ] + } + } + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 86, + "name": "joinPush", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 106, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 85, + "name": "joinedOnce", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 91, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 294, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + }, + { + "id": 89, + "name": "presence", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + }, + { + "id": 88, + "name": "pushBuffer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 87, + "name": "rejoinTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 107, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 92, + "name": "socket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 306, + "name": "default" + } + }, + { + "id": 84, + "name": "state", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 104, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "CHANNEL_STATES" + }, + "defaultValue": "CHANNEL_STATES.closed" + }, + { + "id": 83, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 103, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 90, + "name": "topic", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 119, + "name": "on", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 315, + "character": 2 + } + ], + "signatures": [ + { + "id": 120, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Listen to messages." + }, + "parameters": [ + { + "id": 121, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "broadcast" + } + }, + { + "id": 122, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 123, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 124, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 317, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [124] + } + ] + } + } + }, + { + "id": 125, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 126, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 127, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 128, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 131, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 320, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 130, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 319, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": "broadcast" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [131, 130] + } + ], + "indexSignature": { + "id": 132, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 133, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 134, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 135, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 136, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 137, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 138, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 326, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "sync" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [138] + } + ] + } + } + }, + { + "id": 139, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 140, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 141, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 142, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 143, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 144, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 145, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 146, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 331, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "join" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [146] + } + ] + } + } + }, + { + "id": 147, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 148, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 149, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 150, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 483, + "name": "RealtimePresenceJoinPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 151, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 152, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "presence" + } + }, + { + "id": 153, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 155, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 336, + "character": 14 + } + ], + "type": { + "type": "literal", + "value": "leave" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [155] + } + ] + } + } + }, + { + "id": 156, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 157, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 158, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 159, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 489, + "name": "RealtimePresenceLeavePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 160, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 164, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 162, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 163, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 165, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 166, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 442, + "typeArguments": [ + { + "type": "literal", + "value": "*" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 167, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 168, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 169, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 170, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 449, + "typeArguments": [ + { + "type": "reference", + "id": 164, + "name": "T" + } + ], + "name": "RealtimePostgresChangesPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 171, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 175, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 172, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 173, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 174, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 176, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 177, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 442, + "typeArguments": [ + { + "type": "literal", + "value": "INSERT" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 178, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 179, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 180, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 181, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 454, + "typeArguments": [ + { + "type": "reference", + "id": 175, + "name": "T" + } + ], + "name": "RealtimePostgresInsertPayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 182, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 186, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 183, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 184, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 185, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 187, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 188, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 442, + "typeArguments": [ + { + "type": "literal", + "value": "UPDATE" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 189, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 190, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 191, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 192, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "reference", + "id": 186, + "name": "T" + } + ], + "name": "RealtimePostgresUpdatePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 193, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 197, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 194, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 195, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 196, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 198, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "postgres_changes" + } + }, + { + "id": 199, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 442, + "typeArguments": [ + { + "type": "literal", + "value": "DELETE" + } + ], + "name": "RealtimePostgresChangesFilter" + } + }, + { + "id": 200, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 201, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 202, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 203, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 473, + "typeArguments": [ + { + "type": "reference", + "id": 197, + "name": "T" + } + ], + "name": "RealtimePostgresDeletePayload" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + } + ] + }, + { + "id": 101, + "name": "presenceState", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 284, + "character": 2 + } + ], + "signatures": [ + { + "id": 102, + "name": "presenceState", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "id": 495, + "name": "RealtimePresenceState" + } + } + ] + }, + { + "id": 204, + "name": "send", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 367, + "character": 2 + } + ], + "signatures": [ + { + "id": 205, + "name": "send", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 206, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 207, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 208, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 368, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [208] + } + ], + "indexSignature": { + "id": 209, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 210, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 211, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 212, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 213, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 214, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 305, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 93, + "name": "subscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 171, + "character": 2 + } + ], + "signatures": [ + { + "id": 94, + "name": "subscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Subscribe registers your client with the server" + }, + "parameters": [ + { + "id": 95, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 96, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 97, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 98, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "SUBSCRIBED" + }, + { + "type": "literal", + "value": "TIMED_OUT" + }, + { + "type": "literal", + "value": "CLOSED" + }, + { + "type": "literal", + "value": "CHANNEL_ERROR" + } + ] + } + }, + { + "id": 99, + "name": "err", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 100, + "name": "timeout", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + } + ] + }, + { + "id": 103, + "name": "track", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 288, + "character": 8 + } + ], + "signatures": [ + { + "id": 104, + "name": "track", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 105, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 106, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 107, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 108, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 109, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 110, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 111, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 112, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 305, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 221, + "name": "unsubscribe", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 407, + "character": 2 + } + ], + "signatures": [ + { + "id": 222, + "name": "unsubscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Leaves the channel.", + "text": "Unsubscribes from server events, and instructs channel to terminate on server.\nTriggers onClose() hooks.\n\nTo receive leave acknowledgements, use the a `receive` hook to bind to the server ack, ie:\nchannel.unsubscribe().receive(\"ok\", () => alert(\"left!\") )\n" + }, + "parameters": [ + { + "id": 223, + "name": "timeout", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "error" + }, + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 113, + "name": "untrack", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 302, + "character": 8 + } + ], + "signatures": [ + { + "id": 114, + "name": "untrack", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 115, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 116, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 117, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 118, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 305, + "name": "RealtimeChannelSendResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 215, + "name": "updateJoinPayload", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 394, + "character": 2 + } + ], + "signatures": [ + { + "id": 216, + "name": "updateJoinPayload", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 217, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 219, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 220, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [66] + }, + { + "title": "Properties", + "kind": 1024, + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] + }, + { + "title": "Methods", + "kind": 2048, + "children": [119, 101, 204, 93, 103, 221, 113, 215] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 94, + "character": 21 + } + ] + }, + { + "id": 306, + "name": "RealtimeClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 307, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 88, + "character": 2 + } + ], + "signatures": [ + { + "id": 308, + "name": "new RealtimeClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Initializes the Socket." + }, + "parameters": [ + { + "id": 309, + "name": "endPoint", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 310, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 418, + "name": "RealtimeClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 306, + "name": "default" + } + } + ] + }, + { + "id": 311, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 312, + "name": "channels", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + "defaultValue": "[]" + }, + { + "id": 333, + "name": "conn", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "qualifiedName": "WebSocket", + "package": "typescript", + "name": "WebSocket" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 331, + "name": "decode", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 330, + "name": "encode", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 54, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 313, + "name": "endPoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 342, + "name": "eventsPerSecondLimitMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100" + }, + { + "id": 314, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 315, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 316, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 317, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "DEFAULT_HEADERS" + }, + { + "id": 324, + "name": "heartbeatIntervalMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "30000" + }, + { + "id": 325, + "name": "heartbeatTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "qualifiedName": "global.NodeJS.Timer", + "package": "@types/node", + "name": "Timer" + } + ] + }, + "defaultValue": "undefined" + }, + { + "id": 343, + "name": "inThrottle", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 72, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 329, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 53, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + }, + "defaultValue": "noop" + }, + { + "id": 318, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 320, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 321, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 326, + "name": "pendingHeartbeatRef", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 332, + "name": "reconnectAfterMs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 328, + "name": "reconnectTimer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 52, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + } + }, + { + "id": 327, + "name": "ref", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 51, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 334, + "name": "sendBuffer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 58, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + "defaultValue": "[]" + }, + { + "id": 335, + "name": "serializer", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 59, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "default" + }, + "defaultValue": "..." + }, + { + "id": 336, + "name": "stateChangeCallbacks", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 60, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 337, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 339, + "name": "close", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 62, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 340, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 63, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 341, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 64, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + }, + { + "id": 338, + "name": "open", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 61, + "character": 4 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [339, 340, 341, 338] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 322, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 46, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 323, + "name": "transport", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + }, + "defaultValue": "w3cwebsocket" + }, + { + "id": 366, + "name": "channel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 218, + "character": 2 + } + ], + "signatures": [ + { + "id": 367, + "name": "channel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 368, + "name": "topic", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 369, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 294, + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + } + ] + }, + { + "id": 344, + "name": "connect", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 125, + "character": 2 + } + ], + "signatures": [ + { + "id": 345, + "name": "connect", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Connects the socket, unless already connected." + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 362, + "name": "connectionState", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 198, + "character": 2 + } + ], + "signatures": [ + { + "id": 363, + "name": "connectionState", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the current state of the socket." + }, + "type": { + "type": "reference", + "name": "CONNECTION_STATE" + } + } + ] + }, + { + "id": 346, + "name": "disconnect", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 147, + "character": 2 + } + ], + "signatures": [ + { + "id": 347, + "name": "disconnect", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Disconnects the socket." + }, + "parameters": [ + { + "id": 348, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A numeric status code to send on disconnect." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 349, + "name": "reason", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom reason for the disconnect.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 350, + "name": "getChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 162, + "character": 2 + } + ], + "signatures": [ + { + "id": 351, + "name": "getChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 55, + "name": "default" + } + } + } + ] + }, + { + "id": 364, + "name": "isConnected", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 214, + "character": 2 + } + ], + "signatures": [ + { + "id": 365, + "name": "isConnected", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns `true` is the connection is open." + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 357, + "name": "log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 191, + "character": 2 + } + ], + "signatures": [ + { + "id": 358, + "name": "log", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Logs the message.", + "text": "For customized logging, `this.logger` can be overridden.\n" + }, + "parameters": [ + { + "id": 359, + "name": "kind", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 360, + "name": "msg", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 361, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 370, + "name": "push", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 236, + "character": 2 + } + ], + "signatures": [ + { + "id": 371, + "name": "push", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Push out a message if the socket is connected.", + "text": "If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.\n" + }, + "parameters": [ + { + "id": 372, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 435, + "name": "RealtimeMessage" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "literal", + "value": "rate limited" + } + ] + } + } + ] + }, + { + "id": 355, + "name": "removeAllChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 177, + "character": 2 + } + ], + "signatures": [ + { + "id": 356, + "name": "removeAllChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "id": 499, + "name": "RealtimeRemoveChannelResponse" + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 352, + "name": "removeChannel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 166, + "character": 2 + } + ], + "signatures": [ + { + "id": 353, + "name": "removeChannel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 354, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 499, + "name": "RealtimeRemoveChannelResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 373, + "name": "setAuth", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 263, + "character": 2 + } + ], + "signatures": [ + { + "id": 374, + "name": "setAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + }, + "parameters": [ + { + "id": 375, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A JWT string.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [307] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, 326, 332, 328, 327, + 334, 335, 336, 322, 323 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 40, + "character": 21 + } + ] + }, + { + "id": 1, + "name": "RealtimePresence", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 28, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 83, + "character": 2 + } + ], + "signatures": [ + { + "id": 29, + "name": "new RealtimePresence", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Initializes the Presence." + }, + "parameters": [ + { + "id": 30, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The RealtimeChannel" + }, + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 31, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The options,\n for example `{events: {state: 'state', diff: 'diff'}}`\n" + }, + "type": { + "type": "reference", + "qualifiedName": "PresenceOpts", + "package": "@types/phoenix", + "name": "PresenceOpts" + } + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + } + ] + }, + { + "id": 35, + "name": "caller", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 36, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 37, + "name": "onJoin", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 67, + "character": 4 + } + ], + "type": { + "type": "reference", + "qualifiedName": "PresenceOnJoinCallback", + "package": "@types/phoenix", + "name": "PresenceOnJoinCallback" + } + }, + { + "id": 38, + "name": "onLeave", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 68, + "character": 4 + } + ], + "type": { + "type": "reference", + "qualifiedName": "PresenceOnLeaveCallback", + "package": "@types/phoenix", + "name": "PresenceOnLeaveCallback" + } + }, + { + "id": 39, + "name": "onSync", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 69, + "character": 4 + } + ], + "signatures": [ + { + "id": 40, + "name": "onSync", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [37, 38] + }, + { + "title": "Methods", + "kind": 2048, + "children": [39] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 41, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isPublic": true + }, + "type": { + "type": "reference", + "id": 55, + "name": "default" + } + }, + { + "id": 34, + "name": "joinRef", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 65, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "defaultValue": "null" + }, + { + "id": 33, + "name": "pendingDiffs", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "RawPresenceDiff" + } + }, + "defaultValue": "[]" + }, + { + "id": 32, + "name": "state", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 63, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 495, + "name": "RealtimePresenceState" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [28] + }, + { + "title": "Properties", + "kind": 1024, + "children": [35, 41, 34, 33, 32] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 62, + "character": 21 + } + ] + }, + { + "id": 294, + "name": "RealtimeChannelOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 13, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 295, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 296, + "name": "config", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 297, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 298, + "name": "broadcast", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received" + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 19, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 299, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 301, + "name": "ack", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 19, + "character": 34 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 300, + "name": "self", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 19, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [301, 300] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 19, + "character": 16 + } + ] + } + } + }, + { + "id": 302, + "name": "presence", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "key option is used to track presence payload across clients" + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 23, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 304, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 23, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [304] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 23, + "character": 15 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [298, 302] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 14, + "character": 10 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [296] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 13, + "character": 37 + } + ] + } + } + }, + { + "id": 305, + "name": "RealtimeChannelSendResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 67, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "rate limited" + } + ] + } + }, + { + "id": 418, + "name": "RealtimeClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 16, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 419, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 425, + "name": "decode", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 424, + "name": "encode", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 427, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 428, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 24, + "character": 12 + } + ], + "indexSignature": { + "id": 429, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 430, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 422, + "name": "heartbeatIntervalMs", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 19, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 423, + "name": "logger", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 431, + "name": "params", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 432, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 25, + "character": 11 + } + ], + "indexSignature": { + "id": 433, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 434, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 426, + "name": "reconnectAfterMs", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Function", + "package": "typescript", + "name": "Function" + } + }, + { + "id": 421, + "name": "timeout", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 420, + "name": "transport", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 17, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "WebSocket", + "package": "typescript", + "name": "WebSocket" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 16, + "character": 36 + } + ] + } + } + }, + { + "id": 435, + "name": "RealtimeMessage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 28, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 436, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 438, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "join_ref", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 439, + "name": "payload", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 440, + "name": "ref", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 437, + "name": "topic", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [438, 441, 439, 440, 437] + } + ], + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 28, + "character": 30 + } + ] + } + } + }, + { + "id": 442, + "name": "RealtimePostgresChangesFilter", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 60, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 448, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 443, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 444, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 448, + "name": "T" + } + }, + { + "id": 447, + "name": "filter", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 62, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "table", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 63, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [444, 447, 445, 446] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 60, + "character": 62 + } + ] + } + } + }, + { + "id": 449, + "name": "RealtimePostgresChangesPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 55, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 453, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 55, + "character": 53 + } + ], + "indexSignature": { + "id": 451, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 452, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 454, + "typeArguments": [ + { + "type": "reference", + "id": 453, + "name": "T" + } + ], + "name": "RealtimePostgresInsertPayload" + }, + { + "type": "reference", + "id": 464, + "typeArguments": [ + { + "type": "reference", + "id": 453, + "name": "T" + } + ], + "name": "RealtimePostgresUpdatePayload" + }, + { + "type": "reference", + "id": 473, + "typeArguments": [ + { + "type": "reference", + "id": 453, + "name": "T" + } + ], + "name": "RealtimePostgresDeletePayload" + } + ] + } + }, + { + "id": 473, + "name": "RealtimePostgresDeletePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 48, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 482, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 479, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 48, + "character": 52 + } + ], + "indexSignature": { + "id": 480, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 481, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 474, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 475, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 508, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "" + ] + ] + } + }, + { + "id": 476, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 51, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 477, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 51, + "character": 9 + } + ] + } + } + }, + { + "id": 478, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 52, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 482, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [475, 476, 478] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 49, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 454, + "name": "RealtimePostgresInsertPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 34, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 463, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 460, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 34, + "character": 52 + } + ], + "indexSignature": { + "id": 461, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 462, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 455, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 456, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 36, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 506, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" + }, + "" + ] + ] + } + }, + { + "id": 457, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 37, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 463, + "name": "T" + } + }, + { + "id": 458, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 38, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 459, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 38, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [456, 457, 458] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 35, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 464, + "name": "RealtimePostgresUpdatePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 41, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 472, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 469, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 41, + "character": 52 + } + ], + "indexSignature": { + "id": 470, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 471, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 465, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 466, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 43, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 507, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "" + ] + ] + } + }, + { + "id": 467, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 44, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 472, + "name": "T" + } + }, + { + "id": 468, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 45, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 472, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [466, 467, 468] + } + ], + "sources": [ + { + "fileName": "RealtimeChannel.ts", + "line": 42, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 483, + "name": "RealtimePresenceJoinPayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 20, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 484, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 487, + "name": "currentPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Presence" + } + } + }, + { + "id": 485, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 511, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" + }, + "" + ] + ] + } + }, + { + "id": 486, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 488, + "name": "newPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Presence" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [487, 485, 486, 488] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 20, + "character": 42 + } + ] + } + } + }, + { + "id": 489, + "name": "RealtimePresenceLeavePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 27, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 490, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 493, + "name": "currentPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Presence" + } + } + }, + { + "id": 491, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 512, + "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" + }, + "" + ] + ] + } + }, + { + "id": 492, + "name": "key", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 494, + "name": "leftPresences", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Presence" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [493, 491, 492, 494] + } + ], + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 27, + "character": 43 + } + ] + } + } + }, + { + "id": 495, + "name": "RealtimePresenceState", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 496, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "RealtimePresence.ts", + "line": 18, + "character": 36 + } + ], + "indexSignature": { + "id": 497, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 498, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Presence" + } + } + } + } + } + }, + { + "id": 499, + "name": "RealtimeRemoveChannelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "RealtimeClient.ts", + "line": 36, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "error" + } + ] + } + } + ], + "groups": [ + { + "title": "Enumerations", + "kind": 8, + "children": [500, 504, 509, 513] + }, + { + "title": "Classes", + "kind": 128, + "children": [55, 306, 1] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [294, 305, 418, 435, 442, 449, 473, 454, 464, 483, 489, 495, 499] + } + ], + "sources": [ + { + "fileName": "index.ts", + "line": 1, + "character": 0 + } + ] +} diff --git a/spec/enrichments/tsdoc_v2/realtime_dereferenced.json b/spec/enrichments/tsdoc_v2/realtime_dereferenced.json index f7ae12c4ac5..053a099d227 100644 --- a/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/realtime_dereferenced.json @@ -75,11 +75,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 501, - 503, - 502 - ] + "children": [501, 503, 502] } ], "sources": [ @@ -178,12 +174,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 505, - 508, - 506, - 507 - ] + "children": [505, 508, 506, 507] } ], "sources": [ @@ -263,11 +254,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 511, - 512, - 510 - ] + "children": [511, 512, 510] } ], "sources": [ @@ -366,12 +353,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [ - 517, - 516, - 514, - 515 - ] + "children": [517, 516, 514, 515] } ], "sources": [ @@ -550,10 +532,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -618,9 +597,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -638,10 +615,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -659,9 +633,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -1034,15 +1006,7 @@ "title": "Properties", "kind": 1024, "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 + 425, 424, 427, 422, 423, 431, 426, 421, 420 ] } ], @@ -1662,12 +1626,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -1870,10 +1829,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -1938,9 +1894,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -1958,10 +1912,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -1979,9 +1930,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -2413,13 +2362,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -2535,40 +2478,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -2658,54 +2578,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, 326, + 332, 328, 327, 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 - ] + "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] } ], "sources": [ @@ -2894,12 +2780,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -3165,9 +3046,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -3251,10 +3130,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -3356,9 +3232,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -3457,9 +3331,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -3572,9 +3444,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -3824,12 +3694,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -4095,12 +3960,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -4366,12 +4226,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -4637,12 +4492,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -4804,9 +4654,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -5353,40 +5201,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -5743,17 +5568,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 - ] + "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] } ], "sources": [ @@ -6372,12 +6187,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -6580,10 +6390,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -6648,9 +6455,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -6668,10 +6473,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -6689,9 +6491,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -7123,13 +6923,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -7399,10 +7193,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -7467,9 +7258,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -7487,10 +7276,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -7508,9 +7294,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -7547,53 +7331,21 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, + 329, 318, 326, 332, 328, 327, 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 + 366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373 ] } ], @@ -7783,12 +7535,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -8054,9 +7801,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -8140,10 +7885,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -8245,9 +7987,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -8346,9 +8086,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -8461,9 +8199,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -8713,12 +8449,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -8984,12 +8715,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -9255,12 +8981,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -9526,12 +9247,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -9693,9 +9409,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -10242,40 +9956,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -10365,54 +10056,20 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, 326, 332, 328, 327, + 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 - ] + "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] } ], "sources": [ @@ -10635,10 +10292,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -10703,9 +10357,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -10723,10 +10375,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -10744,9 +10393,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -11119,15 +10766,8 @@ "title": "Properties", "kind": 1024, "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 + 425, 424, 427, 422, 423, 431, 426, + 421, 420 ] } ], @@ -11747,12 +11387,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 339, - 340, - 341, - 338 - ] + "children": [339, 340, 341, 338] } ] } @@ -11955,10 +11590,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -12023,9 +11655,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -12043,10 +11673,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -12064,9 +11691,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -12498,13 +12123,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -12686,53 +12305,21 @@ { "title": "Constructors", "kind": 512, - "children": [ - 307 - ] + "children": [307] }, { "title": "Properties", "kind": 1024, "children": [ - 311, - 312, - 333, - 331, - 330, - 313, - 342, - 314, - 324, - 325, - 343, - 329, - 318, - 326, - 332, - 328, - 327, - 334, - 335, - 336, - 322, - 323 + 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, + 329, 318, 326, 332, 328, 327, 334, 335, 336, 322, 323 ] }, { "title": "Methods", "kind": 2048, "children": [ - 366, - 344, - 362, - 346, - 350, - 364, - 357, - 370, - 355, - 352, - 373 + 366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373 ] } ], @@ -12922,12 +12509,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 81, - 77, - 82, - 76 - ] + "children": [81, 77, 82, 76] } ], "sources": [ @@ -13193,9 +12775,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 124 - ] + "children": [124] } ] } @@ -13279,10 +12859,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 131, - 130 - ] + "children": [131, 130] } ], "indexSignature": { @@ -13384,9 +12961,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 138 - ] + "children": [138] } ] } @@ -13485,9 +13060,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 146 - ] + "children": [146] } ] } @@ -13600,9 +13173,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155 - ] + "children": [155] } ] } @@ -13852,12 +13423,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -14123,12 +13689,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -14394,12 +13955,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -14665,12 +14221,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -14832,9 +14383,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 208 - ] + "children": [208] } ], "indexSignature": { @@ -15381,40 +14930,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 66 - ] + "children": [66] }, { "title": "Properties", "kind": 1024, - "children": [ - 71, - 86, - 85, - 91, - 89, - 88, - 87, - 92, - 84, - 83, - 90 - ] + "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] }, { "title": "Methods", "kind": 2048, - "children": [ - 119, - 101, - 204, - 93, - 103, - 221, - 113, - 215 - ] + "children": [119, 101, 204, 93, 103, 221, 113, 215] } ], "sources": [ @@ -15548,17 +15074,12 @@ { "title": "Properties", "kind": 1024, - "children": [ - 37, - 38 - ] + "children": [37, 38] }, { "title": "Methods", "kind": 2048, - "children": [ - 39 - ] + "children": [39] } ] } @@ -15654,20 +15175,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 28 - ] + "children": [28] }, { "title": "Properties", "kind": 1024, - "children": [ - 35, - 41, - 34, - 33, - 32 - ] + "children": [35, 41, 34, 33, 32] } ], "sources": [ @@ -15794,10 +15307,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 301, - 300 - ] + "children": [301, 300] } ], "sources": [ @@ -15862,9 +15372,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 304 - ] + "children": [304] } ], "sources": [ @@ -15882,10 +15390,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 298, - 302 - ] + "children": [298, 302] } ], "sources": [ @@ -15903,9 +15408,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296 - ] + "children": [296] } ], "sources": [ @@ -16238,17 +15741,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 425, - 424, - 427, - 422, - 423, - 431, - 426, - 421, - 420 - ] + "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] } ], "sources": [ @@ -16380,13 +15873,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 438, - 441, - 439, - 440, - 437 - ] + "children": [438, 441, 439, 440, 437] } ], "sources": [ @@ -16516,12 +16003,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 444, - 447, - 445, - 446 - ] + "children": [444, 447, 445, 446] } ], "sources": [ @@ -16760,11 +16242,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 456, - 457, - 458 - ] + "children": [456, 457, 458] } ], "sources": [ @@ -16936,11 +16414,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 466, - 467, - 468 - ] + "children": [466, 467, 468] } ], "sources": [ @@ -17124,11 +16598,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 475, - 476, - 478 - ] + "children": [475, 476, 478] } ], "sources": [ @@ -17315,11 +16785,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 475, - 476, - 478 - ] + "children": [475, 476, 478] } ], "sources": [ @@ -17495,11 +16961,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 456, - 457, - 458 - ] + "children": [456, 457, 458] } ], "sources": [ @@ -17671,11 +17133,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 466, - 467, - 468 - ] + "children": [466, 467, 468] } ], "sources": [ @@ -17805,12 +17263,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 487, - 485, - 486, - 488 - ] + "children": [487, 485, 486, 488] } ], "sources": [ @@ -17938,12 +17391,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 493, - 491, - 492, - 494 - ] + "children": [493, 491, 492, 494] } ], "sources": [ @@ -18049,40 +17497,17 @@ { "title": "Enumerations", "kind": 8, - "children": [ - 500, - 504, - 509, - 513 - ] + "children": [500, 504, 509, 513] }, { "title": "Classes", "kind": 128, - "children": [ - 55, - 306, - 1 - ] + "children": [55, 306, 1] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 294, - 305, - 418, - 435, - 442, - 449, - 473, - 454, - 464, - 483, - 489, - 495, - 499 - ] + "children": [294, 305, 418, 435, 442, 449, 473, 454, 464, 483, 489, 495, 499] } ], "sources": [ @@ -18092,4 +17517,4 @@ "character": 0 } ] -} \ No newline at end of file +} diff --git a/spec/enrichments/tsdoc_v2/storage.json b/spec/enrichments/tsdoc_v2/storage.json index 8c155d7e995..d94d2aadde8 100644 --- a/spec/enrichments/tsdoc_v2/storage.json +++ b/spec/enrichments/tsdoc_v2/storage.json @@ -1,6933 +1,6868 @@ { - "id": 0, - "name": "@supabase/storage-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 390, - "name": "StorageApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 391, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 392, - "name": "new StorageApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 393, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 390, - "name": "StorageApiError" - }, - "overwrites": { - "type": "reference", - "id": 387, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 386, - "name": "StorageError.constructor" - } - }, - { - "id": 395, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 396, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 397, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 400, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 399, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 401, - "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": [ - 400, - 399, - 401 - ] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 391 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 395 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 396 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 385, - "name": "StorageError" - } - ] - }, - { - "id": 258, - "name": "StorageClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 259, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 6, - "character": 2 - } - ], - "signatures": [ - { - "id": 260, - "name": "new StorageClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 261, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 263, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 264, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 265, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 266, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 267, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 268, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 269, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 270, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 258, - "name": "StorageClient" - }, - "overwrites": { - "type": "reference", - "id": 5, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 4, - "name": "default.constructor" - } - }, - { - "id": 301, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 79, - "character": 8 - } - ], - "signatures": [ - { - "id": 302, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 303, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 304, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 305, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 306, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 81, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 306 - ] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 307, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 308, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 349, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 309, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 308, - 309 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 311, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 312, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 311, - 312 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 44, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 43, - "name": "default.createBucket" - } - }, - { - "id": 338, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 185, - "character": 8 - } - ], - "signatures": [ - { - "id": 339, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 340, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 341, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 342, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 343, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 344, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 344 - ] - } - ] - } - } - }, - { - "id": 345, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 190, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 342, - 345 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 347, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 348, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 347, - 348 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 81, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 80, - "name": "default.deleteBucket" - } - }, - { - "id": 327, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 150, - "character": 8 - } - ], - "signatures": [ - { - "id": 328, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 329, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 330, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 331, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 332, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 333, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 333 - ] - } - ] - } - } - }, - { - "id": 334, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 155, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 331, - 334 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 335, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 336, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 158, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 337, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 159, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 336, - 337 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 70, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 69, - "name": "default.emptyBucket" - } - }, - { - "id": 271, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 15, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform file operation in a bucket." - }, - "parameters": [ - { - "id": 273, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The bucket id to operate on.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "default" - } - } - ] - }, - { - "id": 292, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 293, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 294, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 296, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 297, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 296, - 297 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 298, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 299, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 300, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 299, - 300 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 35, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "default.getBucket" - } - }, - { - "id": 284, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 285, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 286, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 287, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - } - }, - { - "id": 288, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 287, - 288 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 290, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 291, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 290, - 291 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 27, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 26, - "name": "default.listBuckets" - } - }, - { - "id": 313, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 115, - "character": 8 - } - ], - "signatures": [ - { - "id": 314, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 315, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 317, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 318, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 318 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 322 - ] - } - ] - } - } - }, - { - "id": 323, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 320, - 323 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 325, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 124, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 326, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 125, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 325, - 326 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 56, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 55, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 259 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 301, - 338, - 327, - 271, - 292, - 284, - 313 - ] - } - ], - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 5, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 3, - "name": "default" - } - ] - }, - { - "id": 385, - "name": "StorageError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 386, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 387, - "name": "new StorageError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 386 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 390, - "name": "StorageApiError" - }, - { - "type": "reference", - "id": 403, - "name": "StorageUnknownError" - } - ] - }, - { - "id": 403, - "name": "StorageUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 404, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 405, - "name": "new StorageUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 406, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 403, - "name": "StorageUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 387, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 386, - "name": "StorageError.constructor" - } - }, - { - "id": 408, - "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": [ - 404 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 385, - "name": "StorageError" - } - ] - }, - { - "id": 349, - "name": "Bucket", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 353, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 2, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 4, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 355, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 7, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 354, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 353, - 350, - 351, - 352, - 355, - 354 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 378, - "name": "FetchParameters", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 379, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 379 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 17 - } - ] - }, - { - "id": 356, - "name": "FileObject", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 358, - "name": "bucket_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 365, - "name": "buckets", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 362, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 363, - "name": "last_accessed_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 364, - "name": "metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 357, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 359, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 358, - 365, - 362, - 360, - 363, - 364, - 357, - 359, - 361 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 17 - } - ] - }, - { - "id": 369, - "name": "FileOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 370, - "name": "cacheControl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "contentType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "upsert", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 370, - 371, - 372 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 17 - } - ] - }, - { - "id": 380, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 381, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 381 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 17 - } - ] - }, - { - "id": 373, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 374, - "name": "limit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": " The number of files you want to be returned." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 375, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 377, - "name": "search", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The search string to filter files by." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 376, - "name": "sortBy", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 366, - "name": "SortBy" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 374, - 375, - 377, - 376 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 42, - "character": 17 - } - ] - }, - { - "id": 366, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 367, - "name": "column", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 368, - "name": "order", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 367, - 368 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 17 - } - ] - }, - { - "id": 382, - "name": "isStorageError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } - ], - "signatures": [ - { - "id": 383, - "name": "isStorageError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 390, - 258, - 385, - 403 - ] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [ - 349, - 378, - 356, - 369, - 380, - 373, - 366 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [ - 382 - ] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 2, - "name": "packages/StorageBucketApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 12, - "character": 2 - } - ], - "signatures": [ - { - "id": 5, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 6, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 7, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "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" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 11, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "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": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 3, - "name": "default" - } - } - ] - }, - { - "id": 43, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 79, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 45, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 81, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 48 - ] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 349, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 51, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 50, - 51 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 52, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 53, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 54, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 53, - 54 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 80, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 185, - "character": 8 - } - ], - "signatures": [ - { - "id": 81, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 82, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "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/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 86, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 86 - ] - } - ] - } - } - }, - { - "id": 87, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 190, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 84, - 87 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 89, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 90, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 89, - 90 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 69, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 150, - "character": 8 - } - ], - "signatures": [ - { - "id": 70, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 71, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 72, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 73, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 74, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 75, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 75 - ] - } - ] - } - } - }, - { - "id": 76, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 155, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 73, - 76 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 78, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 158, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 79, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 159, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 78, - 79 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 34, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 35, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 36, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 38, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 39, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 38, - 39 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 41, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 42, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 41, - 42 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 26, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 27, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 29, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - } - }, - { - "id": 30, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 29, - 30 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 31, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 32, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 33, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 32, - 33 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 55, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 115, - "character": 8 - } - ], - "signatures": [ - { - "id": 56, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 57, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 58, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 59, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 60, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 60 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 64, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 64 - ] - } - ] - } - } - }, - { - "id": 65, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 62, - 65 - ] - } - ] - } - }, - { - "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/packages/StorageBucketApi.ts", - "line": 124, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 68, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 125, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 67, - 68 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 4 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 43, - 80, - 69, - 34, - 26, - 55 - ] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 7, - "character": 21 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 258, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 3 - ] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 91, - "name": "packages/StorageFileApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 92, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 93, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 94, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 95, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 96, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 98, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 99, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 100, - "name": "bucketId", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 101, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 102, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 103, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 104, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 105, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "default" - } - } - ] - }, - { - "id": 169, - "name": "copy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 226, - "character": 8 - } - ], - "signatures": [ - { - "id": 170, - "name": "copy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 171, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 172, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "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/packages/StorageFileApi.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 176, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 176 - ] - } - ] - } - } - }, - { - "id": 177, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 232, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 174, - 177 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 179, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 235, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 180, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 236, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 179, - 180 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 181, - "name": "createSignedUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 263, - "character": 8 - } - ], - "signatures": [ - { - "id": 182, - "name": "createSignedUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 183, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 184, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 185, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 187, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 266, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 187 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 188, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 189, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 269, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 269, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 191 - ] - } - ] - } - } - }, - { - "id": 192, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 270, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 189, - 192 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 194, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 273, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 195, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 194, - 195 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 196, - "name": "createSignedUrls", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 307, - "character": 8 - } - ], - "signatures": [ - { - "id": 197, - "name": "createSignedUrls", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 198, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 199, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 200, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 202, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 310, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 202 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 204, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 206, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 207, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 208, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 206, - 207, - 208 - ] - } - ] - } - } - } - }, - { - "id": 209, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 314, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 204, - 209 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 317, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 212, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 211, - 212 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 213, - "name": "download", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 355, - "character": 8 - } - ], - "signatures": [ - { - "id": 214, - "name": "download", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Downloads a file." - }, - "parameters": [ - { - "id": 215, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 217, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 359, - "character": 8 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - } - }, - { - "id": 218, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 360, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 217, - 218 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 219, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 220, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 363, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 221, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 364, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 220, - 221 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 222, - "name": "getPublicUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 391, - "character": 2 - } - ], - "signatures": [ - { - "id": 223, - "name": "getPublicUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the URL for an asset in a public bucket.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - }, - "parameters": [ - { - "id": 224, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 226, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 227, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 393, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 227 - ] - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 228, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 229, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 394, - "character": 7 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 231, - "name": "publicUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 394, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 231 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 229 - ] - } - ] - } - } - } - ] - }, - { - "id": 241, - "name": "list", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 506, - "character": 8 - } - ], - "signatures": [ - { - "id": 242, - "name": "list", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all the files within a bucket." - }, - "parameters": [ - { - "id": 243, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The folder path.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 244, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 373, - "name": "SearchOptions" - } - }, - { - "id": 245, - "name": "parameters", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 378, - "name": "FetchParameters" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 247, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 512, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 356, - "name": "FileObject" - } - } - }, - { - "id": 248, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 513, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 247, - 248 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 250, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 516, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 251, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 517, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 250, - 251 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 157, - "name": "move", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 190, - "character": 8 - } - ], - "signatures": [ - { - "id": 158, - "name": "move", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 159, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 162, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 195, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 163, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 164, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 195, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 164 - ] - } - ] - } - } - }, - { - "id": 165, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 196, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 162, - 165 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 166, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 167, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 199, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 168, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 200, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 167, - 168 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 232, - "name": "remove", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 410, - "character": 8 - } - ], - "signatures": [ - { - "id": 233, - "name": "remove", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes files within the same bucket" - }, - "parameters": [ - { - "id": 234, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 236, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 414, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 356, - "name": "FileObject" - } - } - }, - { - "id": 237, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 415, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 236, - 237 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 238, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 239, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 418, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 240, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 419, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 239, - 240 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 144, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 157, - "character": 8 - } - ], - "signatures": [ - { - "id": 145, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." - }, - "parameters": [ - { - "id": 146, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 147, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" - }, - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" - } - ] - } - }, - { - "id": 148, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 369, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 149, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 150, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 173, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 151, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 152, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 173, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 152 - ] - } - ] - } - } - }, - { - "id": 153, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 174, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 150, - 153 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 155, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 177, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 156, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 178, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 155, - 156 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 131, - "name": "upload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 124, - "character": 8 - } - ], - "signatures": [ - { - "id": 132, - "name": "upload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Uploads a file to an existing bucket." - }, - "parameters": [ - { - "id": 133, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 134, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" - }, - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" - } - ] - } - }, - { - "id": 135, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 369, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 137, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 140, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 139 - ] - } - ] - } - } - }, - { - "id": 140, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 141, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 137, - 140 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 142, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 143, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 145, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 142, - 143 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 93 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 169, - 181, - 196, - 213, - 222, - 241, - 157, - 232, - 144, - 131 - ] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 21, - "character": 21 - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 92 - ] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [ - 1, - 2, - 91 - ] - } - ] -} \ No newline at end of file + "id": 0, + "name": "@supabase/storage-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 402, + "name": "StorageApiError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 403, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 17, + "character": 2 + } + ], + "signatures": [ + { + "id": 404, + "name": "new StorageApiError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 405, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 406, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 402, + "name": "StorageApiError" + }, + "overwrites": { + "type": "reference", + "id": 399, + "name": "StorageError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 398, + "name": "StorageError.constructor" + } + }, + { + "id": 407, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 15, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 408, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 23, + "character": 2 + } + ], + "signatures": [ + { + "id": 409, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 410, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 412, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 411, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 413, + "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": [412, 411, 413] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [403] + }, + { + "title": "Properties", + "kind": 1024, + "children": [407] + }, + { + "title": "Methods", + "kind": 2048, + "children": [408] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 397, + "name": "StorageError" + } + ] + }, + { + "id": 266, + "name": "StorageClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 267, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 6, + "character": 2 + } + ], + "signatures": [ + { + "id": 268, + "name": "new StorageClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 269, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 270, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 271, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 272, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 273, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 274, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 275, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 276, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 277, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 278, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 266, + "name": "StorageClient" + }, + "overwrites": { + "type": "reference", + "id": 5, + "name": "default.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 4, + "name": "default.constructor" + } + }, + { + "id": 309, + "name": "createBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 79, + "character": 8 + } + ], + "signatures": [ + { + "id": 310, + "name": "createBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Storage bucket", + "returns": "newly created bucket id\n" + }, + "parameters": [ + { + "id": 311, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are creating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 312, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 313, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 314, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 81, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [314] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 315, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 316, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 8 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 357, + "name": "Bucket" + }, + { + "type": "literal", + "value": "name" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 317, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 85, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [316, 317] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 318, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 319, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 88, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 320, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 89, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [319, 320] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 44, + "name": "default.createBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 43, + "name": "default.createBucket" + } + }, + { + "id": 346, + "name": "deleteBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 185, + "character": 8 + } + ], + "signatures": [ + { + "id": 347, + "name": "deleteBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + }, + "parameters": [ + { + "id": 348, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to delete.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 349, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 350, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 189, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 351, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 352, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 189, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [352] + } + ] + } + } + }, + { + "id": 353, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [350, 353] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 354, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 355, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 193, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 356, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 194, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [355, 356] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 81, + "name": "default.deleteBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 80, + "name": "default.deleteBucket" + } + }, + { + "id": 335, + "name": "emptyBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 150, + "character": 8 + } + ], + "signatures": [ + { + "id": 336, + "name": "emptyBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Removes all objects inside a single bucket." + }, + "parameters": [ + { + "id": 337, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to empty.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 338, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 339, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 154, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 340, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 341, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 154, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [341] + } + ] + } + } + }, + { + "id": 342, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 155, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [339, 342] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 343, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 344, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 158, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 345, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 159, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [344, 345] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 70, + "name": "default.emptyBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 69, + "name": "default.emptyBucket" + } + }, + { + "id": 279, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 15, + "character": 2 + } + ], + "signatures": [ + { + "id": 280, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform file operation in a bucket." + }, + "parameters": [ + { + "id": 281, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The bucket id to operate on.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 92, + "name": "default" + } + } + ] + }, + { + "id": 300, + "name": "getBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 8 + } + ], + "signatures": [ + { + "id": 301, + "name": "getBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing Storage bucket." + }, + "parameters": [ + { + "id": 302, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 304, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 357, + "name": "Bucket" + } + }, + { + "id": 305, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 53, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [304, 305] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 306, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 307, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 56, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 308, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 57, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [307, 308] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 35, + "name": "default.getBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 34, + "name": "default.getBucket" + } + }, + { + "id": 292, + "name": "listBuckets", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 21, + "character": 8 + } + ], + "signatures": [ + { + "id": 293, + "name": "listBuckets", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of all Storage buckets within an existing project." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 294, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 295, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 23, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 357, + "name": "Bucket" + } + } + }, + { + "id": 296, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 24, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [295, 296] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 297, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 298, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 27, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 299, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 28, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [298, 299] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 27, + "name": "default.listBuckets" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 26, + "name": "default.listBuckets" + } + }, + { + "id": 321, + "name": "updateBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 115, + "character": 8 + } + ], + "signatures": [ + { + "id": 322, + "name": "updateBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates a Storage bucket" + }, + "parameters": [ + { + "id": 323, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are updating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 324, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 325, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 326, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 117, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [326] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 327, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 328, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 120, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 329, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 330, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 120, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [330] + } + ] + } + } + }, + { + "id": 331, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [328, 331] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 332, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 333, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 124, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 334, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 125, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [333, 334] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 56, + "name": "default.updateBucket" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 55, + "name": "default.updateBucket" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [267] + }, + { + "title": "Methods", + "kind": 2048, + "children": [309, 346, 335, 279, 300, 292, 321] + } + ], + "sources": [ + { + "fileName": "src/StorageClient.ts", + "line": 5, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 3, + "name": "default" + } + ] + }, + { + "id": 397, + "name": "StorageError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 398, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 2 + } + ], + "signatures": [ + { + "id": 399, + "name": "new StorageError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 400, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [398] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 1, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 402, + "name": "StorageApiError" + }, + { + "type": "reference", + "id": 415, + "name": "StorageUnknownError" + } + ] + }, + { + "id": 415, + "name": "StorageUnknownError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 416, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 35, + "character": 2 + } + ], + "signatures": [ + { + "id": 417, + "name": "new StorageUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 418, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 419, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 415, + "name": "StorageUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 399, + "name": "StorageError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 398, + "name": "StorageError.constructor" + } + }, + { + "id": 420, + "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": [416] + }, + { + "title": "Properties", + "kind": 1024, + "children": [420] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 32, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 397, + "name": "StorageError" + } + ] + }, + { + "id": 357, + "name": "Bucket", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 361, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 5, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 358, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 2, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 359, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 3, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 360, + "name": "owner", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 4, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 363, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 362, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [361, 358, 359, 360, 363, 362] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 17 + } + ] + }, + { + "id": 386, + "name": "FetchParameters", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 387, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Pass in an AbortController's signal to cancel the request." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "AbortSignal", + "package": "typescript", + "name": "AbortSignal" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [387] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 17 + } + ] + }, + { + "id": 364, + "name": "FileObject", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 366, + "name": "bucket_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 12, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 373, + "name": "buckets", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 19, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 357, + "name": "Bucket" + } + }, + { + "id": 370, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 16, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 368, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 371, + "name": "last_accessed_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 17, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 372, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 365, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 367, + "name": "owner", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 13, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 369, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 15, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [366, 373, 370, 368, 371, 372, 365, 367, 369] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 17 + } + ] + }, + { + "id": 377, + "name": "FileOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 378, + "name": "cacheControl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 379, + "name": "contentType", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "upsert", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [378, 379, 380] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 27, + "character": 17 + } + ] + }, + { + "id": 388, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 389, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [389] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 17 + } + ] + }, + { + "id": 381, + "name": "SearchOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 382, + "name": "limit", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": " The number of files you want to be returned." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 46, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 383, + "name": "offset", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The starting position." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 51, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 385, + "name": "search", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The search string to filter files by." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 384, + "name": "sortBy", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The column to sort by. Can be any column inside a FileObject." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 374, + "name": "SortBy" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [382, 383, 385, 384] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 17 + } + ] + }, + { + "id": 374, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 375, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 376, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [375, 376] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 22, + "character": 17 + } + ] + }, + { + "id": 390, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 392, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The height of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "name": "resize", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "cover" + }, + { + "type": "literal", + "value": "contain" + }, + { + "type": "literal", + "value": "fill" + } + ] + } + }, + { + "id": 391, + "name": "width", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The width of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [392, 393, 391] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 17 + } + ] + }, + { + "id": 394, + "name": "isStorageError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 10, + "character": 16 + } + ], + "signatures": [ + { + "id": 395, + "name": "isStorageError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 396, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [402, 266, 397, 415] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [357, 386, 364, 377, 388, 381, 374, 390] + }, + { + "title": "Functions", + "kind": 64, + "children": [394] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 2, + "name": "packages/StorageBucketApi", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 3, + "name": "default", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 4, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 12, + "character": 2 + } + ], + "signatures": [ + { + "id": 5, + "name": "new default", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 6, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 7, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "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" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 11, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "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": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 3, + "name": "default" + } + } + ] + }, + { + "id": 43, + "name": "createBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 79, + "character": 8 + } + ], + "signatures": [ + { + "id": 44, + "name": "createBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Storage bucket", + "returns": "newly created bucket id\n" + }, + "parameters": [ + { + "id": 45, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are creating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 46, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 47, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 48, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 81, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [48] + } + ] + } + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 49, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 50, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 84, + "character": 8 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 357, + "name": "Bucket" + }, + { + "type": "literal", + "value": "name" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 51, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 85, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [50, 51] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 52, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 53, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 88, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 54, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 89, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [53, 54] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 80, + "name": "deleteBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 185, + "character": 8 + } + ], + "signatures": [ + { + "id": 81, + "name": "deleteBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." + }, + "parameters": [ + { + "id": 82, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to delete.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "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/packages/StorageBucketApi.ts", + "line": 189, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 85, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 86, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 189, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [86] + } + ] + } + } + }, + { + "id": 87, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 190, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [84, 87] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 89, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 193, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 90, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 194, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [89, 90] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 69, + "name": "emptyBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 150, + "character": 8 + } + ], + "signatures": [ + { + "id": 70, + "name": "emptyBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Removes all objects inside a single bucket." + }, + "parameters": [ + { + "id": 71, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to empty.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 72, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 73, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 154, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 74, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 75, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 154, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [75] + } + ] + } + } + }, + { + "id": 76, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 155, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [73, 76] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 77, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 78, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 158, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 79, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 159, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [78, 79] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 34, + "name": "getBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 48, + "character": 8 + } + ], + "signatures": [ + { + "id": 35, + "name": "getBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing Storage bucket." + }, + "parameters": [ + { + "id": 36, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique identifier of the bucket you would like to retrieve.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 37, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 38, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 52, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 357, + "name": "Bucket" + } + }, + { + "id": 39, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 53, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [38, 39] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 41, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 56, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 42, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 57, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [41, 42] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 26, + "name": "listBuckets", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 21, + "character": 8 + } + ], + "signatures": [ + { + "id": 27, + "name": "listBuckets", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of all Storage buckets within an existing project." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 28, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 29, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 23, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 357, + "name": "Bucket" + } + } + }, + { + "id": 30, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 24, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [29, 30] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 31, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 32, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 27, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 33, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 28, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [32, 33] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 55, + "name": "updateBucket", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 115, + "character": 8 + } + ], + "signatures": [ + { + "id": 56, + "name": "updateBucket", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates a Storage bucket" + }, + "parameters": [ + { + "id": 57, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "A unique identifier for the bucket you are updating." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 58, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 59, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 60, + "name": "public", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 117, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [60] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 61, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 62, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 120, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 63, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 64, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 120, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [64] + } + ] + } + } + }, + { + "id": 65, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 121, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [62, 65] + } + ] + } + }, + { + "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/packages/StorageBucketApi.ts", + "line": 124, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 68, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 125, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [67, 68] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [4] + }, + { + "title": "Methods", + "kind": 2048, + "children": [43, 80, 69, 34, 26, 55] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 7, + "character": 21 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 266, + "name": "StorageClient" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [3] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageBucketApi.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 91, + "name": "packages/StorageFileApi", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 92, + "name": "default", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 93, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 33, + "character": 2 + } + ], + "signatures": [ + { + "id": 94, + "name": "new default", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 95, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 96, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 97, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 98, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 99, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + }, + "defaultValue": "{}" + }, + { + "id": 100, + "name": "bucketId", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 101, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 102, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 103, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 104, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 105, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 92, + "name": "default" + } + } + ] + }, + { + "id": 169, + "name": "copy", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 232, + "character": 8 + } + ], + "signatures": [ + { + "id": 170, + "name": "copy", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Copies an existing file to a new path in the same bucket." + }, + "parameters": [ + { + "id": 171, + "name": "fromPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The original file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 172, + "name": "toPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "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/packages/StorageFileApi.ts", + "line": 237, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 175, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 176, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 237, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [176] + } + ] + } + } + }, + { + "id": 177, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 238, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [174, 177] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 178, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 179, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 241, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 180, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 242, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [179, 180] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 181, + "name": "createSignedUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 270, + "character": 8 + } + ], + "signatures": [ + { + "id": 182, + "name": "createSignedUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." + }, + "parameters": [ + { + "id": 183, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 184, + "name": "expiresIn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 185, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 186, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 187, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 273, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 188, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 273, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [187, 188] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 189, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 190, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 276, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 191, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 192, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 276, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [192] + } + ] + } + } + }, + { + "id": 193, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 277, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [190, 193] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 194, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 195, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 280, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 196, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 281, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [195, 196] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 197, + "name": "createSignedUrls", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 315, + "character": 8 + } + ], + "signatures": [ + { + "id": 198, + "name": "createSignedUrls", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." + }, + "parameters": [ + { + "id": 199, + "name": "paths", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 200, + "name": "expiresIn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 201, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 202, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 203, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 318, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [203] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 204, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 205, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 321, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 207, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 321, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 208, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 321, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 209, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 321, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [207, 208, 209] + } + ] + } + } + } + }, + { + "id": 210, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 322, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [205, 210] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 211, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 212, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 325, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 213, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 326, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [212, 213] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 214, + "name": "download", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 364, + "character": 8 + } + ], + "signatures": [ + { + "id": 215, + "name": "download", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Downloads a file." + }, + "parameters": [ + { + "id": 216, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 217, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 366, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 220, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 221, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 369, + "character": 8 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + } + }, + { + "id": 222, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 370, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [221, 222] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 223, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 224, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 373, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 225, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 374, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [224, 225] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 226, + "name": "getPublicUrl", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 407, + "character": 2 + } + ], + "signatures": [ + { + "id": 227, + "name": "getPublicUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the URL for an asset in a public bucket.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." + }, + "parameters": [ + { + "id": 228, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 229, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 231, + "name": "download", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 409, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 232, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 409, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [231, 232] + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 233, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 234, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 410, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 235, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 236, + "name": "publicUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 410, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [236] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [234] + } + ] + } + } + } + ] + }, + { + "id": 246, + "name": "list", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 541, + "character": 8 + } + ], + "signatures": [ + { + "id": 247, + "name": "list", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Lists all the files within a bucket." + }, + "parameters": [ + { + "id": 248, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The folder path.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 381, + "name": "SearchOptions" + } + }, + { + "id": 250, + "name": "parameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 386, + "name": "FetchParameters" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 251, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 252, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 547, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 364, + "name": "FileObject" + } + } + }, + { + "id": 253, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 548, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [252, 253] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 254, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 255, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 551, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 256, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 552, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [255, 256] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 157, + "name": "move", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 196, + "character": 8 + } + ], + "signatures": [ + { + "id": 158, + "name": "move", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Moves an existing file to a new path in the same bucket." + }, + "parameters": [ + { + "id": 159, + "name": "fromPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The original file path, including the current file name. For example `folder/image.png`." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 160, + "name": "toPath", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 162, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 201, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 163, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 164, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 201, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [164] + } + ] + } + } + }, + { + "id": 165, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 202, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [162, 165] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 167, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 205, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 168, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 206, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [167, 168] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 237, + "name": "remove", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 445, + "character": 8 + } + ], + "signatures": [ + { + "id": 238, + "name": "remove", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Deletes files within the same bucket" + }, + "parameters": [ + { + "id": 239, + "name": "paths", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 240, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 241, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 449, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 364, + "name": "FileObject" + } + } + }, + { + "id": 242, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 450, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [241, 242] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 243, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 244, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 453, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 245, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 454, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [244, 245] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 144, + "name": "update", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 163, + "character": 8 + } + ], + "signatures": [ + { + "id": 145, + "name": "update", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Replaces an existing file at the specified path with a new one." + }, + "parameters": [ + { + "id": 146, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 147, + "name": "fileBody", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The body of the file to be stored in the bucket.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "ArrayBuffer", + "package": "typescript", + "name": "ArrayBuffer" + }, + { + "type": "reference", + "qualifiedName": "ArrayBufferView", + "package": "typescript", + "name": "ArrayBufferView" + }, + { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + }, + { + "type": "reference", + "qualifiedName": "Buffer", + "package": "@types/node", + "name": "Buffer" + }, + { + "type": "reference", + "qualifiedName": "File", + "package": "typescript", + "name": "File" + }, + { + "type": "reference", + "qualifiedName": "FormData", + "package": "typescript", + "name": "FormData" + }, + { + "type": "reference", + "qualifiedName": "NodeJS.ReadableStream", + "package": "@types/node", + "name": "ReadableStream" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + ], + "qualifiedName": "ReadableStream", + "package": "typescript", + "name": "ReadableStream" + }, + { + "type": "reference", + "qualifiedName": "URLSearchParams", + "package": "typescript", + "name": "URLSearchParams" + } + ] + } + }, + { + "id": 148, + "name": "fileOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 377, + "name": "FileOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 149, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 150, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 179, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 151, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 152, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 179, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [152] + } + ] + } + } + }, + { + "id": 153, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 180, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [150, 153] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 155, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 183, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 156, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 184, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [155, 156] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 131, + "name": "upload", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 130, + "character": 8 + } + ], + "signatures": [ + { + "id": 132, + "name": "upload", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Uploads a file to an existing bucket." + }, + "parameters": [ + { + "id": 133, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 134, + "name": "fileBody", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The body of the file to be stored in the bucket.\n" + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "ArrayBuffer", + "package": "typescript", + "name": "ArrayBuffer" + }, + { + "type": "reference", + "qualifiedName": "ArrayBufferView", + "package": "typescript", + "name": "ArrayBufferView" + }, + { + "type": "reference", + "qualifiedName": "Blob", + "package": "typescript", + "name": "Blob" + }, + { + "type": "reference", + "qualifiedName": "Buffer", + "package": "@types/node", + "name": "Buffer" + }, + { + "type": "reference", + "qualifiedName": "File", + "package": "typescript", + "name": "File" + }, + { + "type": "reference", + "qualifiedName": "FormData", + "package": "typescript", + "name": "FormData" + }, + { + "type": "reference", + "qualifiedName": "NodeJS.ReadableStream", + "package": "@types/node", + "name": "ReadableStream" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Uint8Array", + "package": "typescript", + "name": "Uint8Array" + } + ], + "qualifiedName": "ReadableStream", + "package": "typescript", + "name": "ReadableStream" + }, + { + "type": "reference", + "qualifiedName": "URLSearchParams", + "package": "typescript", + "name": "URLSearchParams" + } + ] + } + }, + { + "id": 135, + "name": "fileOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 377, + "name": "FileOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 136, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 137, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 146, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 138, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 139, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 146, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [139] + } + ] + } + } + }, + { + "id": 140, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 147, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [137, 140] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 141, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 142, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 150, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 143, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 151, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 397, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [142, 143] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [93] + }, + { + "title": "Methods", + "kind": 2048, + "children": [169, 181, 197, 214, 226, 246, 157, 237, 144, 131] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 27, + "character": 21 + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "kind": 128, + "children": [92] + } + ], + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [1, 2, 91] + } + ] +} diff --git a/spec/enrichments/tsdoc_v2/storage_dereferenced.json b/spec/enrichments/tsdoc_v2/storage_dereferenced.json index 6860d984baf..d85e05b52d8 100644 --- a/spec/enrichments/tsdoc_v2/storage_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/storage_dereferenced.json @@ -13,14 +13,14 @@ "flags": {}, "children": [ { - "id": 390, + "id": 402, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 391, + "id": 403, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -34,14 +34,14 @@ ], "signatures": [ { - "id": 392, + "id": 404, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 393, + "id": 405, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52,7 +52,7 @@ } }, { - "id": 394, + "id": 406, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -65,24 +65,24 @@ ], "type": { "type": "reference", - "id": 390, + "id": 402, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 387, + "id": 399, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 386, + "id": 398, "name": "StorageError.constructor" } }, { - "id": 395, + "id": 407, "name": "status", "kind": 1024, "kindString": "Property", @@ -100,7 +100,7 @@ } }, { - "id": 396, + "id": 408, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -114,7 +114,7 @@ ], "signatures": [ { - "id": 397, + "id": 409, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -122,14 +122,14 @@ "type": { "type": "reflection", "declaration": { - "id": 398, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 400, + "id": 412, "name": "message", "kind": 1024, "kindString": "Property", @@ -148,7 +148,7 @@ "defaultValue": "..." }, { - "id": 399, + "id": 411, "name": "name", "kind": 1024, "kindString": "Property", @@ -167,7 +167,7 @@ "defaultValue": "..." }, { - "id": 401, + "id": 413, "name": "status", "kind": 1024, "kindString": "Property", @@ -190,11 +190,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 400, - 399, - 401 - ] + "children": [412, 411, 413] } ] } @@ -207,23 +203,17 @@ { "title": "Constructors", "kind": 512, - "children": [ - 391 - ] + "children": [403] }, { "title": "Properties", "kind": 1024, - "children": [ - 395 - ] + "children": [407] }, { "title": "Methods", "kind": 2048, - "children": [ - 396 - ] + "children": [408] } ], "sources": [ @@ -236,20 +226,20 @@ "extendedTypes": [ { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } ] }, { - "id": 258, + "id": 266, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 259, + "id": 267, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -263,14 +253,14 @@ ], "signatures": [ { - "id": 260, + "id": 268, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 261, + "id": 269, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -281,7 +271,7 @@ } }, { - "id": 262, + "id": 270, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -289,20 +279,20 @@ "type": { "type": "reflection", "declaration": { - "id": 263, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 264, + "id": 272, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 265, + "id": 273, "name": "key", "kind": 32768, "flags": {}, @@ -322,7 +312,7 @@ "defaultValue": "{}" }, { - "id": 266, + "id": 274, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -332,21 +322,21 @@ "type": { "type": "reflection", "declaration": { - "id": 267, + "id": 275, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 268, + "id": 276, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 269, + "id": 277, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -359,7 +349,7 @@ } }, { - "id": 270, + "id": 278, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -396,7 +386,7 @@ ], "type": { "type": "reference", - "id": 258, + "id": 266, "name": "StorageClient" }, "overwrites": { @@ -413,7 +403,7 @@ } }, { - "id": 301, + "id": 309, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -427,7 +417,7 @@ ], "signatures": [ { - "id": 302, + "id": 310, "name": "createBucket", "kind": 4096, "kindString": "Call signature", @@ -438,7 +428,7 @@ }, "parameters": [ { - "id": 303, + "id": 311, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -452,7 +442,7 @@ } }, { - "id": 304, + "id": 312, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -460,14 +450,14 @@ "type": { "type": "reflection", "declaration": { - "id": 305, + "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 306, + "id": 314, "name": "public", "kind": 1024, "kindString": "Property", @@ -492,9 +482,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 306 - ] + "children": [314] } ] } @@ -511,14 +499,14 @@ { "type": "reflection", "declaration": { - "id": 307, + "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 308, + "id": 316, "name": "data", "kind": 1024, "kindString": "Property", @@ -535,7 +523,7 @@ "typeArguments": [ { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" }, { @@ -549,7 +537,7 @@ } }, { - "id": 309, + "id": 317, "name": "error", "kind": 1024, "kindString": "Property", @@ -571,10 +559,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 308, - 309 - ] + "children": [316, 317] } ] } @@ -582,14 +567,14 @@ { "type": "reflection", "declaration": { - "id": 310, + "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 311, + "id": 319, "name": "data", "kind": 1024, "kindString": "Property", @@ -607,7 +592,7 @@ } }, { - "id": 312, + "id": 320, "name": "error", "kind": 1024, "kindString": "Property", @@ -621,7 +606,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -630,10 +615,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 311, - 312 - ] + "children": [319, 320] } ] } @@ -659,7 +641,7 @@ } }, { - "id": 338, + "id": 346, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -673,7 +655,7 @@ ], "signatures": [ { - "id": 339, + "id": 347, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", @@ -683,7 +665,7 @@ }, "parameters": [ { - "id": 340, + "id": 348, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -706,14 +688,14 @@ { "type": "reflection", "declaration": { - "id": 341, + "id": 349, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 350, "name": "data", "kind": 1024, "kindString": "Property", @@ -728,14 +710,14 @@ "type": { "type": "reflection", "declaration": { - "id": 343, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 344, + "id": 352, "name": "message", "kind": 1024, "kindString": "Property", @@ -757,16 +739,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 344 - ] + "children": [352] } ] } } }, { - "id": 345, + "id": 353, "name": "error", "kind": 1024, "kindString": "Property", @@ -788,10 +768,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 342, - 345 - ] + "children": [350, 353] } ] } @@ -799,14 +776,14 @@ { "type": "reflection", "declaration": { - "id": 346, + "id": 354, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 347, + "id": 355, "name": "data", "kind": 1024, "kindString": "Property", @@ -824,7 +801,7 @@ } }, { - "id": 348, + "id": 356, "name": "error", "kind": 1024, "kindString": "Property", @@ -838,7 +815,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -847,10 +824,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 347, - 348 - ] + "children": [355, 356] } ] } @@ -876,7 +850,7 @@ } }, { - "id": 327, + "id": 335, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -890,7 +864,7 @@ ], "signatures": [ { - "id": 328, + "id": 336, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", @@ -900,7 +874,7 @@ }, "parameters": [ { - "id": 329, + "id": 337, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -923,14 +897,14 @@ { "type": "reflection", "declaration": { - "id": 330, + "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 331, + "id": 339, "name": "data", "kind": 1024, "kindString": "Property", @@ -945,14 +919,14 @@ "type": { "type": "reflection", "declaration": { - "id": 332, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 333, + "id": 341, "name": "message", "kind": 1024, "kindString": "Property", @@ -974,16 +948,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 333 - ] + "children": [341] } ] } } }, { - "id": 334, + "id": 342, "name": "error", "kind": 1024, "kindString": "Property", @@ -1005,10 +977,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 331, - 334 - ] + "children": [339, 342] } ] } @@ -1016,14 +985,14 @@ { "type": "reflection", "declaration": { - "id": 335, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 344, "name": "data", "kind": 1024, "kindString": "Property", @@ -1041,7 +1010,7 @@ } }, { - "id": 337, + "id": 345, "name": "error", "kind": 1024, "kindString": "Property", @@ -1055,7 +1024,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -1064,10 +1033,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 336, - 337 - ] + "children": [344, 345] } ] } @@ -1093,7 +1059,7 @@ } }, { - "id": 271, + "id": 279, "name": "from", "kind": 2048, "kindString": "Method", @@ -1107,7 +1073,7 @@ ], "signatures": [ { - "id": 272, + "id": 280, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1117,7 +1083,7 @@ }, "parameters": [ { - "id": 273, + "id": 281, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1140,7 +1106,7 @@ ] }, { - "id": 292, + "id": 300, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -1154,7 +1120,7 @@ ], "signatures": [ { - "id": 293, + "id": 301, "name": "getBucket", "kind": 4096, "kindString": "Call signature", @@ -1164,7 +1130,7 @@ }, "parameters": [ { - "id": 294, + "id": 302, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1187,14 +1153,14 @@ { "type": "reflection", "declaration": { - "id": 295, + "id": 303, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 296, + "id": 304, "name": "data", "kind": 1024, "kindString": "Property", @@ -1208,12 +1174,12 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, { - "id": 297, + "id": 305, "name": "error", "kind": 1024, "kindString": "Property", @@ -1235,10 +1201,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 296, - 297 - ] + "children": [304, 305] } ] } @@ -1246,14 +1209,14 @@ { "type": "reflection", "declaration": { - "id": 298, + "id": 306, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 299, + "id": 307, "name": "data", "kind": 1024, "kindString": "Property", @@ -1271,7 +1234,7 @@ } }, { - "id": 300, + "id": 308, "name": "error", "kind": 1024, "kindString": "Property", @@ -1285,7 +1248,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -1294,10 +1257,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 299, - 300 - ] + "children": [307, 308] } ] } @@ -1323,7 +1283,7 @@ } }, { - "id": 284, + "id": 292, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -1337,7 +1297,7 @@ ], "signatures": [ { - "id": 285, + "id": 293, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", @@ -1354,14 +1314,14 @@ { "type": "reflection", "declaration": { - "id": 286, + "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 287, + "id": 295, "name": "data", "kind": 1024, "kindString": "Property", @@ -1377,13 +1337,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } } }, { - "id": 288, + "id": 296, "name": "error", "kind": 1024, "kindString": "Property", @@ -1405,10 +1365,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 287, - 288 - ] + "children": [295, 296] } ] } @@ -1416,14 +1373,14 @@ { "type": "reflection", "declaration": { - "id": 289, + "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 290, + "id": 298, "name": "data", "kind": 1024, "kindString": "Property", @@ -1441,7 +1398,7 @@ } }, { - "id": 291, + "id": 299, "name": "error", "kind": 1024, "kindString": "Property", @@ -1455,7 +1412,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -1464,10 +1421,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 290, - 291 - ] + "children": [298, 299] } ] } @@ -1493,7 +1447,7 @@ } }, { - "id": 313, + "id": 321, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -1507,7 +1461,7 @@ ], "signatures": [ { - "id": 314, + "id": 322, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", @@ -1517,7 +1471,7 @@ }, "parameters": [ { - "id": 315, + "id": 323, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1531,7 +1485,7 @@ } }, { - "id": 316, + "id": 324, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1539,14 +1493,14 @@ "type": { "type": "reflection", "declaration": { - "id": 317, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 318, + "id": 326, "name": "public", "kind": 1024, "kindString": "Property", @@ -1571,9 +1525,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 318 - ] + "children": [326] } ] } @@ -1589,14 +1541,14 @@ { "type": "reflection", "declaration": { - "id": 319, + "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 320, + "id": 328, "name": "data", "kind": 1024, "kindString": "Property", @@ -1611,14 +1563,14 @@ "type": { "type": "reflection", "declaration": { - "id": 321, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 322, + "id": 330, "name": "message", "kind": 1024, "kindString": "Property", @@ -1640,16 +1592,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 322 - ] + "children": [330] } ] } } }, { - "id": 323, + "id": 331, "name": "error", "kind": 1024, "kindString": "Property", @@ -1671,10 +1621,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 320, - 323 - ] + "children": [328, 331] } ] } @@ -1682,14 +1629,14 @@ { "type": "reflection", "declaration": { - "id": 324, + "id": 332, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 325, + "id": 333, "name": "data", "kind": 1024, "kindString": "Property", @@ -1707,7 +1654,7 @@ } }, { - "id": 326, + "id": 334, "name": "error", "kind": 1024, "kindString": "Property", @@ -1721,7 +1668,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -1730,10 +1677,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 325, - 326 - ] + "children": [333, 334] } ] } @@ -1763,22 +1707,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 259 - ] + "children": [267] }, { "title": "Methods", "kind": 2048, - "children": [ - 301, - 338, - 327, - 271, - 292, - 284, - 313 - ] + "children": [309, 346, 335, 279, 300, 292, 321] } ], "sources": [ @@ -1797,14 +1731,14 @@ ] }, { - "id": 385, + "id": 397, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 386, + "id": 398, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1818,14 +1752,14 @@ ], "signatures": [ { - "id": 387, + "id": 399, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 388, + "id": 400, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1838,7 +1772,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" }, "overwrites": { @@ -1857,9 +1791,7 @@ { "title": "Constructors", "kind": 512, - "children": [ - 386 - ] + "children": [398] } ], "sources": [ @@ -1880,25 +1812,25 @@ "extendedBy": [ { "type": "reference", - "id": 390, + "id": 402, "name": "StorageApiError" }, { "type": "reference", - "id": 403, + "id": 415, "name": "StorageUnknownError" } ] }, { - "id": 403, + "id": 415, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 404, + "id": 416, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1912,14 +1844,14 @@ ], "signatures": [ { - "id": 405, + "id": 417, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 406, + "id": 418, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1930,7 +1862,7 @@ } }, { - "id": 407, + "id": 419, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -1943,24 +1875,24 @@ ], "type": { "type": "reference", - "id": 403, + "id": 415, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 387, + "id": 399, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 386, + "id": 398, "name": "StorageError.constructor" } }, { - "id": 408, + "id": 420, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -1982,16 +1914,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 404 - ] + "children": [416] }, { "title": "Properties", "kind": 1024, - "children": [ - 408 - ] + "children": [420] } ], "sources": [ @@ -2004,20 +1932,20 @@ "extendedTypes": [ { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } ] }, { - "id": 349, + "id": 357, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 353, + "id": 361, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2035,7 +1963,7 @@ } }, { - "id": 350, + "id": 358, "name": "id", "kind": 1024, "kindString": "Property", @@ -2053,7 +1981,7 @@ } }, { - "id": 351, + "id": 359, "name": "name", "kind": 1024, "kindString": "Property", @@ -2071,7 +1999,7 @@ } }, { - "id": 352, + "id": 360, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2089,7 +2017,7 @@ } }, { - "id": 355, + "id": 363, "name": "public", "kind": 1024, "kindString": "Property", @@ -2107,7 +2035,7 @@ } }, { - "id": 354, + "id": 362, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2129,14 +2057,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 353, - 350, - 351, - 352, - 355, - 354 - ] + "children": [361, 358, 359, 360, 363, 362] } ], "sources": [ @@ -2148,14 +2069,14 @@ ] }, { - "id": 378, + "id": 386, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 379, + "id": 387, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2184,9 +2105,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 379 - ] + "children": [387] } ], "sources": [ @@ -2198,14 +2117,14 @@ ] }, { - "id": 356, + "id": 364, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 358, + "id": 366, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2223,7 +2142,7 @@ } }, { - "id": 365, + "id": 373, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -2237,12 +2156,12 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, { - "id": 362, + "id": 370, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2260,7 +2179,7 @@ } }, { - "id": 360, + "id": 368, "name": "id", "kind": 1024, "kindString": "Property", @@ -2278,7 +2197,7 @@ } }, { - "id": 363, + "id": 371, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2296,7 +2215,7 @@ } }, { - "id": 364, + "id": 372, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2326,7 +2245,7 @@ } }, { - "id": 357, + "id": 365, "name": "name", "kind": 1024, "kindString": "Property", @@ -2344,7 +2263,7 @@ } }, { - "id": 359, + "id": 367, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2362,7 +2281,7 @@ } }, { - "id": 361, + "id": 369, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2384,17 +2303,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 358, - 365, - 362, - 360, - 363, - 364, - 357, - 359, - 361 - ] + "children": [366, 373, 370, 368, 371, 372, 365, 367, 369] } ], "sources": [ @@ -2406,14 +2315,14 @@ ] }, { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -2436,7 +2345,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -2459,7 +2368,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -2486,11 +2395,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -2502,14 +2407,14 @@ ] }, { - "id": 380, + "id": 388, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 381, + "id": 389, "name": "name", "kind": 1024, "kindString": "Property", @@ -2531,9 +2436,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 381 - ] + "children": [389] } ], "sources": [ @@ -2545,14 +2448,14 @@ ] }, { - "id": 373, + "id": 381, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 374, + "id": 382, "name": "limit", "kind": 1024, "kindString": "Property", @@ -2575,7 +2478,7 @@ } }, { - "id": 375, + "id": 383, "name": "offset", "kind": 1024, "kindString": "Property", @@ -2598,7 +2501,7 @@ } }, { - "id": 377, + "id": 385, "name": "search", "kind": 1024, "kindString": "Property", @@ -2621,7 +2524,7 @@ } }, { - "id": 376, + "id": 384, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -2640,7 +2543,7 @@ ], "type": { "type": "reference", - "id": 366, + "id": 374, "name": "SortBy" } } @@ -2649,12 +2552,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 374, - 375, - 377, - 376 - ] + "children": [382, 383, 385, 384] } ], "sources": [ @@ -2666,14 +2564,14 @@ ] }, { - "id": 366, + "id": 374, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 367, + "id": 375, "name": "column", "kind": 1024, "kindString": "Property", @@ -2693,7 +2591,7 @@ } }, { - "id": 368, + "id": 376, "name": "order", "kind": 1024, "kindString": "Property", @@ -2717,10 +2615,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 367, - 368 - ] + "children": [375, 376] } ], "sources": [ @@ -2732,7 +2627,112 @@ ] }, { - "id": 382, + "id": 390, + "name": "TransformOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 392, + "name": "height", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The height of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 393, + "name": "resize", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "cover" + }, + { + "type": "literal", + "value": "contain" + }, + { + "type": "literal", + "value": "fill" + } + ] + } + }, + { + "id": 391, + "name": "width", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The width of the image in pixels." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [392, 393, 391] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 17 + } + ] + }, + { + "id": 394, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -2746,14 +2746,14 @@ ], "signatures": [ { - "id": 383, + "id": 395, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 384, + "id": 396, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -2770,7 +2770,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -2782,32 +2782,17 @@ { "title": "Classes", "kind": 128, - "children": [ - 390, - 258, - 385, - 403 - ] + "children": [402, 266, 397, 415] }, { "title": "Interfaces", "kind": 256, - "children": [ - 349, - 378, - 356, - 369, - 380, - 373, - 366 - ] + "children": [357, 386, 364, 377, 388, 381, 374, 390] }, { "title": "Functions", "kind": 64, - "children": [ - 382 - ] + "children": [394] } ], "sources": [ @@ -3066,9 +3051,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 48 - ] + "children": [48] } ] } @@ -3109,7 +3092,7 @@ "typeArguments": [ { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" }, { @@ -3145,10 +3128,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 50, - 51 - ] + "children": [50, 51] } ] } @@ -3195,7 +3175,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -3204,10 +3184,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 53, - 54 - ] + "children": [53, 54] } ] } @@ -3321,9 +3298,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 86 - ] + "children": [86] } ] } @@ -3352,10 +3327,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 84, - 87 - ] + "children": [84, 87] } ] } @@ -3402,7 +3374,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -3411,10 +3383,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 89, - 90 - ] + "children": [89, 90] } ] } @@ -3528,9 +3497,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 75 - ] + "children": [75] } ] } @@ -3559,10 +3526,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 73, - 76 - ] + "children": [73, 76] } ] } @@ -3609,7 +3573,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -3618,10 +3582,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 78, - 79 - ] + "children": [78, 79] } ] } @@ -3705,7 +3666,7 @@ ], "type": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } }, @@ -3732,10 +3693,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 38, - 39 - ] + "children": [38, 39] } ] } @@ -3782,7 +3740,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -3791,10 +3749,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 41, - 42 - ] + "children": [41, 42] } ] } @@ -3864,7 +3819,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 349, + "id": 357, "name": "Bucket" } } @@ -3892,10 +3847,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 29, - 30 - ] + "children": [29, 30] } ] } @@ -3942,7 +3894,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -3951,10 +3903,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 32, - 33 - ] + "children": [32, 33] } ] } @@ -4048,9 +3997,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 60 - ] + "children": [60] } ] } @@ -4117,9 +4064,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 64 - ] + "children": [64] } ] } @@ -4148,10 +4093,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 62, - 65 - ] + "children": [62, 65] } ] } @@ -4198,7 +4140,7 @@ ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -4207,10 +4149,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 67, - 68 - ] + "children": [67, 68] } ] } @@ -4230,21 +4169,12 @@ { "title": "Constructors", "kind": 512, - "children": [ - 4 - ] + "children": [4] }, { "title": "Methods", "kind": 2048, - "children": [ - 43, - 80, - 69, - 34, - 26, - 55 - ] + "children": [43, 80, 69, 34, 26, 55] } ], "sources": [ @@ -4257,7 +4187,7 @@ "extendedBy": [ { "type": "reference", - "id": 258, + "id": 266, "name": "StorageClient" } ] @@ -4267,9 +4197,7 @@ { "title": "Classes", "kind": 128, - "children": [ - 3 - ] + "children": [3] } ], "sources": [ @@ -4303,7 +4231,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 27, + "line": 33, "character": 2 } ], @@ -4470,7 +4398,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 226, + "line": 232, "character": 8 } ], @@ -4538,7 +4466,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, + "line": 237, "character": 8 } ], @@ -4560,7 +4488,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 231, + "line": 237, "character": 16 } ], @@ -4574,9 +4502,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 176 - ] + "children": [176] } ] } @@ -4591,7 +4517,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 232, + "line": 238, "character": 8 } ], @@ -4605,10 +4531,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 174, - 177 - ] + "children": [174, 177] } ] } @@ -4631,7 +4554,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 235, + "line": 241, "character": 8 } ], @@ -4649,13 +4572,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 236, + "line": 242, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -4664,10 +4587,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 179, - 180 - ] + "children": [179, 180] } ] } @@ -4691,7 +4611,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 263, + "line": 270, "character": 8 } ], @@ -4756,14 +4676,16 @@ "name": "download", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 266, + "line": 273, "character": 16 } ], @@ -4780,15 +4702,37 @@ } ] } + }, + { + "id": 188, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 273, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [ - 187 - ] + "children": [187, 188] } ] } @@ -4804,14 +4748,14 @@ { "type": "reflection", "declaration": { - "id": 188, + "id": 189, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 189, + "id": 190, "name": "data", "kind": 1024, "kindString": "Property", @@ -4819,21 +4763,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 276, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 190, + "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 191, + "id": 192, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -4841,7 +4785,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 276, "character": 16 } ], @@ -4855,16 +4799,14 @@ { "title": "Properties", "kind": 1024, - "children": [ - 191 - ] + "children": [192] } ] } } }, { - "id": 192, + "id": 193, "name": "error", "kind": 1024, "kindString": "Property", @@ -4872,7 +4814,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 270, + "line": 277, "character": 8 } ], @@ -4886,10 +4828,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 189, - 192 - ] + "children": [190, 193] } ] } @@ -4897,14 +4836,14 @@ { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 194, + "id": 195, "name": "data", "kind": 1024, "kindString": "Property", @@ -4912,7 +4851,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 273, + "line": 280, "character": 8 } ], @@ -4922,7 +4861,7 @@ } }, { - "id": 195, + "id": 196, "name": "error", "kind": 1024, "kindString": "Property", @@ -4930,13 +4869,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 274, + "line": 281, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -4945,10 +4884,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 194, - 195 - ] + "children": [195, 196] } ] } @@ -4964,7 +4900,7 @@ ] }, { - "id": 196, + "id": 197, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -4972,13 +4908,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 315, "character": 8 } ], "signatures": [ { - "id": 197, + "id": 198, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", @@ -4988,7 +4924,7 @@ }, "parameters": [ { - "id": 198, + "id": 199, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -5005,7 +4941,7 @@ } }, { - "id": 199, + "id": 200, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -5019,7 +4955,7 @@ } }, { - "id": 200, + "id": 201, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5029,14 +4965,14 @@ "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 203, "name": "download", "kind": 1024, "kindString": "Property", @@ -5047,7 +4983,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 310, + "line": 318, "character": 16 } ], @@ -5070,9 +5006,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 202 - ] + "children": [203] } ] } @@ -5088,14 +5022,14 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 204, + "id": 205, "name": "data", "kind": 1024, "kindString": "Property", @@ -5103,7 +5037,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 8 } ], @@ -5112,14 +5046,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 205, + "id": 206, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 206, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -5127,7 +5061,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 16 } ], @@ -5146,7 +5080,7 @@ } }, { - "id": 207, + "id": 208, "name": "path", "kind": 1024, "kindString": "Property", @@ -5154,7 +5088,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 38 } ], @@ -5173,7 +5107,7 @@ } }, { - "id": 208, + "id": 209, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -5181,7 +5115,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 313, + "line": 321, "character": 59 } ], @@ -5195,11 +5129,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 206, - 207, - 208 - ] + "children": [207, 208, 209] } ] } @@ -5207,7 +5137,7 @@ } }, { - "id": 209, + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -5215,7 +5145,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 314, + "line": 322, "character": 8 } ], @@ -5229,10 +5159,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 204, - 209 - ] + "children": [205, 210] } ] } @@ -5240,14 +5167,14 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 211, + "id": 212, "name": "data", "kind": 1024, "kindString": "Property", @@ -5255,7 +5182,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 317, + "line": 325, "character": 8 } ], @@ -5265,7 +5192,7 @@ } }, { - "id": 212, + "id": 213, "name": "error", "kind": 1024, "kindString": "Property", @@ -5273,13 +5200,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 318, + "line": 326, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -5288,10 +5215,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 211, - 212 - ] + "children": [212, 213] } ] } @@ -5307,7 +5231,7 @@ ] }, { - "id": 213, + "id": 214, "name": "download", "kind": 2048, "kindString": "Method", @@ -5315,13 +5239,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 355, + "line": 364, "character": 8 } ], "signatures": [ { - "id": 214, + "id": 215, "name": "download", "kind": 4096, "kindString": "Call signature", @@ -5331,18 +5255,70 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "path", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`.\n" + "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 217, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 366, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } } ], "type": { @@ -5354,14 +5330,14 @@ { "type": "reflection", "declaration": { - "id": 216, + "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 217, + "id": 221, "name": "data", "kind": 1024, "kindString": "Property", @@ -5369,7 +5345,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 359, + "line": 369, "character": 8 } ], @@ -5381,7 +5357,7 @@ } }, { - "id": 218, + "id": 222, "name": "error", "kind": 1024, "kindString": "Property", @@ -5389,7 +5365,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 360, + "line": 370, "character": 8 } ], @@ -5403,10 +5379,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 217, - 218 - ] + "children": [221, 222] } ] } @@ -5414,14 +5387,14 @@ { "type": "reflection", "declaration": { - "id": 219, + "id": 223, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 220, + "id": 224, "name": "data", "kind": 1024, "kindString": "Property", @@ -5429,7 +5402,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 363, + "line": 373, "character": 8 } ], @@ -5439,7 +5412,7 @@ } }, { - "id": 221, + "id": 225, "name": "error", "kind": 1024, "kindString": "Property", @@ -5447,13 +5420,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 364, + "line": 374, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -5462,10 +5435,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 220, - 221 - ] + "children": [224, 225] } ] } @@ -5481,7 +5451,7 @@ ] }, { - "id": 222, + "id": 226, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -5489,13 +5459,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 391, + "line": 407, "character": 2 } ], "signatures": [ { - "id": 223, + "id": 227, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", @@ -5505,7 +5475,7 @@ }, "parameters": [ { - "id": 224, + "id": 228, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -5519,7 +5489,7 @@ } }, { - "id": 225, + "id": 229, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5529,25 +5499,27 @@ "type": { "type": "reflection", "declaration": { - "id": 226, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 227, + "id": 231, "name": "download", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" + "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." }, "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 393, + "line": 409, "character": 16 } ], @@ -5564,15 +5536,37 @@ } ] } + }, + { + "id": 232, + "name": "transform", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Transform the asset before serving it to the client.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 409, + "character": 45 + } + ], + "type": { + "type": "reference", + "id": 390, + "name": "TransformOptions" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [ - 227 - ] + "children": [231, 232] } ] } @@ -5582,14 +5576,14 @@ "type": { "type": "reflection", "declaration": { - "id": 228, + "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 229, + "id": 234, "name": "data", "kind": 1024, "kindString": "Property", @@ -5597,21 +5591,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 394, + "line": 410, "character": 7 } ], "type": { "type": "reflection", "declaration": { - "id": 230, + "id": 235, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 231, + "id": 236, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -5619,7 +5613,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 394, + "line": 410, "character": 15 } ], @@ -5633,9 +5627,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 231 - ] + "children": [236] } ] } @@ -5646,9 +5638,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 229 - ] + "children": [234] } ] } @@ -5657,7 +5647,7 @@ ] }, { - "id": 241, + "id": 246, "name": "list", "kind": 2048, "kindString": "Method", @@ -5665,13 +5655,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 506, + "line": 541, "character": 8 } ], "signatures": [ { - "id": 242, + "id": 247, "name": "list", "kind": 4096, "kindString": "Call signature", @@ -5681,7 +5671,7 @@ }, "parameters": [ { - "id": 243, + "id": 248, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -5697,7 +5687,7 @@ } }, { - "id": 244, + "id": 249, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5706,17 +5696,17 @@ }, "type": { "type": "reference", - "id": 373, + "id": 381, "name": "SearchOptions", "dereferenced": { - "id": 373, + "id": 381, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 374, + "id": 382, "name": "limit", "kind": 1024, "kindString": "Property", @@ -5739,7 +5729,7 @@ } }, { - "id": 375, + "id": 383, "name": "offset", "kind": 1024, "kindString": "Property", @@ -5762,7 +5752,7 @@ } }, { - "id": 377, + "id": 385, "name": "search", "kind": 1024, "kindString": "Property", @@ -5785,7 +5775,7 @@ } }, { - "id": 376, + "id": 384, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -5804,7 +5794,7 @@ ], "type": { "type": "reference", - "id": 366, + "id": 374, "name": "SortBy" } } @@ -5813,12 +5803,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 374, - 375, - 377, - 376 - ] + "children": [382, 383, 385, 384] } ], "sources": [ @@ -5832,7 +5817,7 @@ } }, { - "id": 245, + "id": 250, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -5841,17 +5826,17 @@ }, "type": { "type": "reference", - "id": 378, + "id": 386, "name": "FetchParameters", "dereferenced": { - "id": 378, + "id": 386, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 379, + "id": 387, "name": "signal", "kind": 1024, "kindString": "Property", @@ -5880,9 +5865,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 379 - ] + "children": [387] } ], "sources": [ @@ -5905,14 +5888,14 @@ { "type": "reflection", "declaration": { - "id": 246, + "id": 251, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 247, + "id": 252, "name": "data", "kind": 1024, "kindString": "Property", @@ -5920,7 +5903,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 512, + "line": 547, "character": 8 } ], @@ -5928,13 +5911,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 356, + "id": 364, "name": "FileObject" } } }, { - "id": 248, + "id": 253, "name": "error", "kind": 1024, "kindString": "Property", @@ -5942,7 +5925,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 513, + "line": 548, "character": 8 } ], @@ -5956,10 +5939,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 247, - 248 - ] + "children": [252, 253] } ] } @@ -5967,14 +5947,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 255, "name": "data", "kind": 1024, "kindString": "Property", @@ -5982,7 +5962,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 551, "character": 8 } ], @@ -5992,7 +5972,7 @@ } }, { - "id": 251, + "id": 256, "name": "error", "kind": 1024, "kindString": "Property", @@ -6000,13 +5980,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 517, + "line": 552, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -6015,10 +5995,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 250, - 251 - ] + "children": [255, 256] } ] } @@ -6042,7 +6019,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 190, + "line": 196, "character": 8 } ], @@ -6110,7 +6087,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 195, + "line": 201, "character": 8 } ], @@ -6132,7 +6109,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 195, + "line": 201, "character": 16 } ], @@ -6146,9 +6123,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 164 - ] + "children": [164] } ] } @@ -6163,7 +6138,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 196, + "line": 202, "character": 8 } ], @@ -6177,10 +6152,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 162, - 165 - ] + "children": [162, 165] } ] } @@ -6203,7 +6175,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 199, + "line": 205, "character": 8 } ], @@ -6221,13 +6193,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 200, + "line": 206, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -6236,10 +6208,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 167, - 168 - ] + "children": [167, 168] } ] } @@ -6255,7 +6224,7 @@ ] }, { - "id": 232, + "id": 237, "name": "remove", "kind": 2048, "kindString": "Method", @@ -6263,13 +6232,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 410, + "line": 445, "character": 8 } ], "signatures": [ { - "id": 233, + "id": 238, "name": "remove", "kind": 4096, "kindString": "Call signature", @@ -6279,7 +6248,7 @@ }, "parameters": [ { - "id": 234, + "id": 239, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -6305,14 +6274,14 @@ { "type": "reflection", "declaration": { - "id": 235, + "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 241, "name": "data", "kind": 1024, "kindString": "Property", @@ -6320,7 +6289,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 414, + "line": 449, "character": 8 } ], @@ -6328,13 +6297,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 356, + "id": 364, "name": "FileObject" } } }, { - "id": 237, + "id": 242, "name": "error", "kind": 1024, "kindString": "Property", @@ -6342,7 +6311,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 415, + "line": 450, "character": 8 } ], @@ -6356,10 +6325,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 236, - 237 - ] + "children": [241, 242] } ] } @@ -6367,14 +6333,14 @@ { "type": "reflection", "declaration": { - "id": 238, + "id": 243, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 239, + "id": 244, "name": "data", "kind": 1024, "kindString": "Property", @@ -6382,7 +6348,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 418, + "line": 453, "character": 8 } ], @@ -6392,7 +6358,7 @@ } }, { - "id": 240, + "id": 245, "name": "error", "kind": 1024, "kindString": "Property", @@ -6400,13 +6366,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 419, + "line": 454, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -6415,10 +6381,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 239, - 240 - ] + "children": [244, 245] } ] } @@ -6442,7 +6405,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 157, + "line": 163, "character": 8 } ], @@ -6562,17 +6525,17 @@ }, "type": { "type": "reference", - "id": 369, + "id": 377, "name": "FileOptions", "dereferenced": { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -6595,7 +6558,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -6618,7 +6581,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -6645,11 +6608,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -6687,7 +6646,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 173, + "line": 179, "character": 8 } ], @@ -6709,7 +6668,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 173, + "line": 179, "character": 16 } ], @@ -6723,9 +6682,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 152 - ] + "children": [152] } ] } @@ -6740,7 +6697,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 174, + "line": 180, "character": 8 } ], @@ -6754,10 +6711,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 150, - 153 - ] + "children": [150, 153] } ] } @@ -6780,7 +6734,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 177, + "line": 183, "character": 8 } ], @@ -6798,13 +6752,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 178, + "line": 184, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -6813,10 +6767,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 155, - 156 - ] + "children": [155, 156] } ] } @@ -6840,7 +6791,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 124, + "line": 130, "character": 8 } ], @@ -6960,17 +6911,17 @@ }, "type": { "type": "reference", - "id": 369, + "id": 377, "name": "FileOptions", "dereferenced": { - "id": 369, + "id": 377, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 370, + "id": 378, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -6993,7 +6944,7 @@ } }, { - "id": 371, + "id": 379, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -7016,7 +6967,7 @@ } }, { - "id": 372, + "id": 380, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -7043,11 +6994,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 370, - 371, - 372 - ] + "children": [378, 379, 380] } ], "sources": [ @@ -7085,7 +7032,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 140, + "line": 146, "character": 8 } ], @@ -7107,7 +7054,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 140, + "line": 146, "character": 16 } ], @@ -7121,9 +7068,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 139 - ] + "children": [139] } ] } @@ -7138,7 +7083,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 147, "character": 8 } ], @@ -7152,10 +7097,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 137, - 140 - ] + "children": [137, 140] } ] } @@ -7178,7 +7120,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 144, + "line": 150, "character": 8 } ], @@ -7196,13 +7138,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 145, + "line": 151, "character": 8 } ], "type": { "type": "reference", - "id": 385, + "id": 397, "name": "StorageError" } } @@ -7211,10 +7153,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 142, - 143 - ] + "children": [142, 143] } ] } @@ -7234,31 +7173,18 @@ { "title": "Constructors", "kind": 512, - "children": [ - 93 - ] + "children": [93] }, { "title": "Methods", "kind": 2048, - "children": [ - 169, - 181, - 196, - 213, - 222, - 241, - 157, - 232, - 144, - 131 - ] + "children": [169, 181, 197, 214, 226, 246, 157, 237, 144, 131] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 21, + "line": 27, "character": 21 } ] @@ -7268,9 +7194,7 @@ { "title": "Classes", "kind": 128, - "children": [ - 92 - ] + "children": [92] } ], "sources": [ @@ -7286,11 +7210,7 @@ { "title": "Modules", "kind": 2, - "children": [ - 1, - 2, - 91 - ] + "children": [1, 2, 91] } ] -} \ No newline at end of file +} diff --git a/spec/enrichments/tsdoc_v2/supabase.json b/spec/enrichments/tsdoc_v2/supabase.json index 75865bde7b1..598143907ff 100644 --- a/spec/enrichments/tsdoc_v2/supabase.json +++ b/spec/enrichments/tsdoc_v2/supabase.json @@ -1,4118 +1,4012 @@ { - "id": 0, - "name": "@supabase/supabase-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 194, - "name": "SupabaseClientOptions", - "kind": 16777216, - "kindString": "Reference", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 20, - "character": 14 - } - ], - "target": 61 - }, - { - "id": 104, - "name": "SupabaseClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" - }, - "children": [ - { - "id": 105, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 82, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "new SupabaseClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "typeParameter": [ - { - "id": 107, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 108, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 109, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 110, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 111, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 112, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 108, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 104, - "typeArguments": [ - { - "type": "reference", - "id": 107, - "name": "Database" - }, - { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 109, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - }, - { - "id": 115, - "name": "authUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 57, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 126, - "name": "changedAccessToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 64, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 121, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 63, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 122, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 123, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 124, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 125, - "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": 117, - "name": "functionsUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 59, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 127, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 66, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 129, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 130, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 118, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 60, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - }, - { - "id": 114, - "name": "realtimeUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 119, - "name": "rest", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 61, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 107, - "name": "Database" - }, - { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "qualifiedName": "GenericSchema", - "package": "@supabase/postgrest-js", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 120, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 62, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "storageUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 58, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 132, - "name": "supabaseKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "supabaseUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 133, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 137, - "character": 6 - } - ], - "getSignature": [ - { - "id": 134, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] - }, - { - "id": 135, - "name": "storage", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 147, - "character": 6 - } - ], - "getSignature": [ - { - "id": 136, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } - } - ] - }, - { - "id": 169, - "name": "_getAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 234, - "character": 16 - } - ], - "signatures": [ - { - "id": 170, - "name": "_getAccessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 186, - "name": "_handleTokenChanged", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 281, - "character": 10 - } - ], - "signatures": [ - { - "id": 187, - "name": "_handleTokenChanged", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 188, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "AuthChangeEvent", - "package": "@supabase/gotrue-js", - "name": "AuthChangeEvent" - } - }, - { - "id": 189, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 190, - "name": "source", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "CLIENT" - }, - { - "type": "literal", - "value": "STORAGE" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 180, - "name": "_initRealtimeClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 267, - "character": 10 - } - ], - "signatures": [ - { - "id": 181, - "name": "_initRealtimeClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 182, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 171, - "name": "_initSupabaseAuthClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 240, - "character": 10 - } - ], - "signatures": [ - { - "id": 172, - "name": "_initSupabaseAuthClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 173, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - }, - { - "id": 174, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 175, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 177, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 178, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 179, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - } - ] - }, - { - "id": 183, - "name": "_listenForAuthEvents", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 274, - "character": 10 - } - ], - "signatures": [ - { - "id": 184, - "name": "_listenForAuthEvents", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 185, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 158, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 206, - "character": 2 - } - ], - "signatures": [ - { - "id": 159, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - }, - "parameters": [ - { - "id": 160, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 161, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 137, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 156, - "character": 2 - } - ], - "signatures": [ - { - "id": 138, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a table operation." - }, - "typeParameter": [ - { - "id": 139, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 140, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 79, - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 141, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 139, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "reference", - "id": 140, - "name": "Table" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 142, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 143, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 144, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 92, - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 145, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 143, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "reference", - "id": 144, - "name": "View" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 146, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 147, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - }, - { - "id": 162, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 163, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all Realtime channels." - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - } - ] - }, - { - "id": 167, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 230, - "character": 2 - } - ], - "signatures": [ - { - "id": 168, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 164, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 223, - "character": 2 - } - ], - "signatures": [ - { - "id": 165, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." - }, - "parameters": [ - { - "id": 166, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 148, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 177, - "character": 2 - } - ], - "signatures": [ - { - "id": 149, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a function call." - }, - "typeParameter": [ - { - "id": 150, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 151, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 93, - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 152, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The function name to call." - }, - "type": { - "type": "reference", - "id": 150, - "name": "FunctionName" - } - }, - { - "id": 153, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The parameters to pass to the function call." - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 154, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 157, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows in a table.\n\n" - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 185, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 156, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to true, no data will be returned." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 184, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 157, - 156 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - } - ], - "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 105 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 113, - 115, - 126, - 121, - 117, - 127, - 118, - 114, - 119, - 120, - 116, - 132, - 131 - ] - }, - { - "title": "Accessors", - "kind": 262144, - "children": [ - 133, - 135 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 169, - 186, - 180, - 171, - 183, - 158, - 137, - 162, - 167, - 164, - 148 - ] - } - ], - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 42, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 191, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 192, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 193, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 2, - "name": "createClient", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Supabase Client." - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 9, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 104, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "References", - "kind": 16777216, - "children": [ - 194 - ] - }, - { - "title": "Classes", - "kind": 128, - "children": [ - 104 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [ - 2 - ] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 10, - "name": "lib/constants", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 11, - "name": "DEFAULT_HEADERS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 13, - "name": "X-Client-Info", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 33 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 13 - ] - } - ] - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 11 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 14, - "name": "lib/fetch", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 29, - "name": "fetchWithAuth", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 30, - "name": "fetchWithAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 31, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "getAccessToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 34, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 35, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 36, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 37, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 38, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 39, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 41, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 42, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 43, - "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": 15, - "name": "resolveFetch", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 5, - "character": 13 - } - ], - "signatures": [ - { - "id": 16, - "name": "resolveFetch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 17, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 19, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 21, - "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" - } - } - ] - } - } - } - ], - "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": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "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": 26, - "name": "resolveHeadersConstructor", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 27, - "name": "resolveHeadersConstructor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [ - 29, - 15, - 26 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 44, - "name": "lib/helpers", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 50, - "name": "applySettingDefaults", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 51, - "name": "applySettingDefaults", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 53, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 54, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - }, - { - "id": 55, - "name": "defaults", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ] - }, - { - "id": 56, - "name": "isBrowser", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 16, - "character": 13 - } - ], - "signatures": [ - { - "id": 57, - "name": "isBrowser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 47, - "name": "stripTrailingSlash", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 12, - "character": 16 - } - ], - "signatures": [ - { - "id": 48, - "name": "stripTrailingSlash", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 49, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 45, - "name": "uuid", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 4, - "character": 16 - } - ], - "signatures": [ - { - "id": 46, - "name": "uuid", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [ - 50, - 56, - 47, - 45 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 58, - "name": "lib/types", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 59, - "name": "SupabaseAuthClientOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "GoTrueClientOptions" - } - ] - }, - { - "id": 60, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 18, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - }, - { - "id": 93, - "name": "GenericFunction", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 95, - "name": "Args", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 75, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 96, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 95, - 96 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 30 - } - ] - } - } - }, - { - "id": 89, - "name": "GenericNonUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 90, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 91, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 91 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 38 - } - ] - } - } - }, - { - "id": 97, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 98, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 101, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 93, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 99, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 79, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 100, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 92, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 101, - 99, - 100 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 28 - } - ] - } - } - }, - { - "id": 79, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 82, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 81, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 83, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 82, - 81, - 83 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 27 - } - ] - } - } - }, - { - "id": 84, - "name": "GenericUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 87, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 86, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 88, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 87, - 86, - 88 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 35 - } - ] - } - } - }, - { - "id": 92, - "name": "GenericView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 84, - "name": "GenericUpdatableView" - }, - { - "type": "reference", - "id": 89, - "name": "GenericNonUpdatableView" - } - ] - } - }, - { - "id": 61, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 78, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 62, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 66, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 68, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged in users." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 70, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged in session to storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 72, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 69, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 9 - } - ] - } - } - }, - { - "id": 63, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 78, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 65 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 7 - } - ] - } - } - }, - { - "id": 74, - "name": "global", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 75, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 76, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 60, - "name": "Fetch" - } - }, - { - "id": 77, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 76, - 77 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 11 - } - ] - } - } - }, - { - "id": 73, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 48 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Interfaces", - "kind": 256, - "children": [ - 59 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 60, - 93, - 89, - 97, - 79, - 84, - 92, - 61 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 102, - "name": "lib/version", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 103, - "name": "version", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "0.0.0-automated" - }, - "defaultValue": "'0.0.0-automated'" - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 103 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [ - 1, - 10, - 14, - 44, - 58, - 102 - ] - } - ] -} \ No newline at end of file + "id": 0, + "name": "@supabase/supabase-js", + "kind": 1, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 1, + "name": "index", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 194, + "name": "SupabaseClientOptions", + "kind": 16777216, + "kindString": "Reference", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 20, + "character": 14 + } + ], + "target": 61 + }, + { + "id": 104, + "name": "SupabaseClient", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Supabase Client.", + "text": "An isomorphic Javascript client for interacting with Postgres.\n" + }, + "children": [ + { + "id": 105, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 82, + "character": 2 + } + ], + "signatures": [ + { + "id": 106, + "name": "new SupabaseClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "typeParameter": [ + { + "id": 107, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 108, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 107, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 109, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 110, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 111, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 112, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 108, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 104, + "typeArguments": [ + { + "type": "reference", + "id": 107, + "name": "Database" + }, + { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 109, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 113, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 54, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + }, + { + "id": 115, + "name": "authUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 57, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 126, + "name": "changedAccessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 64, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 121, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 63, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 122, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 123, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 124, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 125, + "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": 117, + "name": "functionsUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 59, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 127, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 66, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 129, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 130, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 118, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 60, + "character": 12 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + }, + { + "id": 114, + "name": "realtimeUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 56, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 119, + "name": "rest", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 61, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 107, + "name": "Database" + }, + { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "qualifiedName": "GenericSchema", + "package": "@supabase/postgrest-js", + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "qualifiedName": "PostgrestClient", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 120, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 62, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 116, + "name": "storageUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 58, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 132, + "name": "supabaseKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 131, + "name": "supabaseUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 133, + "name": "functions", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 137, + "character": 6 + } + ], + "getSignature": [ + { + "id": 134, + "name": "functions", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Functions allows you to deploy and invoke edge functions." + }, + "type": { + "type": "reference", + "qualifiedName": "FunctionsClient", + "package": "@supabase/functions-js", + "name": "FunctionsClient" + } + } + ] + }, + { + "id": 135, + "name": "storage", + "kind": 262144, + "kindString": "Accessor", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 147, + "character": 6 + } + ], + "getSignature": [ + { + "id": 136, + "name": "storage", + "kind": 524288, + "kindString": "Get signature", + "flags": {}, + "comment": { + "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." + }, + "type": { + "type": "reference", + "qualifiedName": "StorageClient", + "package": "@supabase/storage-js", + "name": "StorageClient" + } + } + ] + }, + { + "id": 169, + "name": "_getAccessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 234, + "character": 16 + } + ], + "signatures": [ + { + "id": 170, + "name": "_getAccessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 186, + "name": "_handleTokenChanged", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 281, + "character": 10 + } + ], + "signatures": [ + { + "id": 187, + "name": "_handleTokenChanged", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 188, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "AuthChangeEvent", + "package": "@supabase/gotrue-js", + "name": "AuthChangeEvent" + } + }, + { + "id": 189, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 190, + "name": "source", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "CLIENT" + }, + { + "type": "literal", + "value": "STORAGE" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 180, + "name": "_initRealtimeClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 267, + "character": 10 + } + ], + "signatures": [ + { + "id": 181, + "name": "_initRealtimeClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 182, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClient", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 171, + "name": "_initSupabaseAuthClient", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 240, + "character": 10 + } + ], + "signatures": [ + { + "id": 172, + "name": "_initSupabaseAuthClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 173, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 59, + "name": "SupabaseAuthClientOptions" + } + }, + { + "id": 174, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 175, + "name": "fetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 177, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 178, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 179, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "name": "SupabaseAuthClient" + } + } + ] + }, + { + "id": 183, + "name": "_listenForAuthEvents", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 274, + "character": 10 + } + ], + "signatures": [ + { + "id": 184, + "name": "_listenForAuthEvents", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 185, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ] + }, + { + "id": 158, + "name": "channel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 206, + "character": 2 + } + ], + "signatures": [ + { + "id": 159, + "name": "channel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." + }, + "parameters": [ + { + "id": 160, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 161, + "name": "opts", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The options to pass to the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannelOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeChannelOptions" + }, + "defaultValue": "..." + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ] + }, + { + "id": 137, + "name": "from", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 156, + "character": 2 + } + ], + "signatures": [ + { + "id": 138, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a table operation." + }, + "typeParameter": [ + { + "id": 139, + "name": "TableName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 140, + "name": "Table", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 79, + "name": "GenericTable" + } + } + ], + "parameters": [ + { + "id": 141, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 139, + "name": "TableName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Schema" + }, + { + "type": "reference", + "id": 140, + "name": "Table" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 142, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 143, + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 144, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 92, + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 145, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 143, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Schema" + }, + { + "type": "reference", + "id": 144, + "name": "View" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + }, + { + "id": 146, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 147, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Schema" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "PostgrestQueryBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + }, + { + "id": 162, + "name": "getChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 213, + "character": 2 + } + ], + "signatures": [ + { + "id": 163, + "name": "getChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns all Realtime channels." + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + } + ] + }, + { + "id": 167, + "name": "removeAllChannels", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 230, + "character": 2 + } + ], + "signatures": [ + { + "id": 168, + "name": "removeAllChannels", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "error" + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 164, + "name": "removeChannel", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 223, + "character": 2 + } + ], + "signatures": [ + { + "id": 165, + "name": "removeChannel", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Unsubscribes and removes Realtime channel from Realtime client." + }, + "parameters": [ + { + "id": 166, + "name": "channel", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The name of the Realtime channel.\n\n" + }, + "type": { + "type": "reference", + "qualifiedName": "RealtimeChannel", + "package": "@supabase/realtime-js", + "name": "default" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ok" + }, + { + "type": "literal", + "value": "timed out" + }, + { + "type": "literal", + "value": "error" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 148, + "name": "rpc", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 177, + "character": 2 + } + ], + "signatures": [ + { + "id": 149, + "name": "rpc", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Perform a function call." + }, + "typeParameter": [ + { + "id": 150, + "name": "FunctionName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 151, + "name": "Function_", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 93, + "name": "GenericFunction" + } + } + ], + "parameters": [ + { + "id": 152, + "name": "fn", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The function name to call." + }, + "type": { + "type": "reference", + "id": 150, + "name": "FunctionName" + } + }, + { + "id": 153, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The parameters to pass to the function call." + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Args" + }, + "objectType": { + "type": "reference", + "id": 151, + "name": "Function_" + } + }, + "defaultValue": "{}" + }, + { + "id": 154, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 157, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Count algorithm to use to count rows in a table.\n\n" + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 185, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 156, + "name": "head", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "When set to true, no data will be returned." + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 184, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [157, 156] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 109, + "name": "Schema" + }, + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 151, + "name": "Function_" + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + } + }, + "extendsType": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Returns" + }, + "objectType": { + "type": "reference", + "id": 151, + "name": "Function_" + } + } + ], + "qualifiedName": "PostgrestFilterBuilder", + "package": "@supabase/postgrest-js", + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [105] + }, + { + "title": "Properties", + "kind": 1024, + "children": [113, 115, 126, 121, 117, 127, 118, 114, 119, 120, 116, 132, 131] + }, + { + "title": "Accessors", + "kind": 262144, + "children": [133, 135] + }, + { + "title": "Methods", + "kind": 2048, + "children": [169, 186, 180, 171, 183, 158, 137, 162, 167, 164, 148] + } + ], + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 42, + "character": 21 + } + ], + "typeParameter": [ + { + "id": 191, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 192, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 107, + "name": "Database" + } + } + ] + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 107, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 193, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 108, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 107, + "name": "Database" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ] + }, + { + "id": 2, + "name": "createClient", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 25, + "character": 13 + } + ], + "signatures": [ + { + "id": 3, + "name": "createClient", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new Supabase Client." + }, + "typeParameter": [ + { + "id": 4, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 5, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 4, + "name": "Database" + } + } + ] + } + } + }, + { + "id": 6, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + "objectType": { + "type": "reference", + "id": 4, + "name": "Database" + } + }, + "extendsType": { + "type": "reference", + "id": 97, + "name": "GenericSchema" + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "any" + }, + "objectType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "parameters": [ + { + "id": 7, + "name": "supabaseUrl", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 9, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 5, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 104, + "typeArguments": [ + { + "type": "reference", + "id": 4, + "name": "Database" + }, + { + "type": "reference", + "id": 5, + "name": "SchemaName" + }, + { + "type": "reference", + "id": 6, + "name": "Schema" + } + ], + "name": "default" + } + } + ] + } + ], + "groups": [ + { + "title": "References", + "kind": 16777216, + "children": [194] + }, + { + "title": "Classes", + "kind": 128, + "children": [104] + }, + { + "title": "Functions", + "kind": 64, + "children": [2] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 10, + "name": "lib/constants", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 11, + "name": "DEFAULT_HEADERS", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "X-Client-Info", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 3, + "character": 33 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [13] + } + ] + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [11] + } + ], + "sources": [ + { + "fileName": "src/lib/constants.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 14, + "name": "lib/fetch", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 29, + "name": "fetchWithAuth", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 25, + "character": 13 + } + ], + "signatures": [ + { + "id": 30, + "name": "fetchWithAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 31, + "name": "supabaseKey", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "getAccessToken", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 33, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 34, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + }, + { + "id": 35, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 36, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 37, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 38, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 39, + "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" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 41, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 42, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 43, + "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": 15, + "name": "resolveFetch", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 5, + "character": 13 + } + ], + "signatures": [ + { + "id": 16, + "name": "resolveFetch", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 17, + "name": "customFetch", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 19, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 20, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "id": 21, + "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" + } + } + ] + } + } + } + ], + "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": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + } + }, + { + "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": 26, + "name": "resolveHeadersConstructor", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 17, + "character": 13 + } + ], + "signatures": [ + { + "id": 27, + "name": "resolveHeadersConstructor", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 28, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [29, 15, 26] + } + ], + "sources": [ + { + "fileName": "src/lib/fetch.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 44, + "name": "lib/helpers", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 50, + "name": "applySettingDefaults", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 18, + "character": 16 + } + ], + "signatures": [ + { + "id": 51, + "name": "applySettingDefaults", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 52, + "name": "Database", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 53, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "default": { + "type": "conditional", + "checkType": { + "type": "literal", + "value": "public" + }, + "extendsType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 52, + "name": "Database" + } + }, + "trueType": { + "type": "literal", + "value": "public" + }, + "falseType": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 52, + "name": "Database" + } + } + ] + } + } + } + ], + "parameters": [ + { + "id": 54, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 53, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + }, + { + "id": 55, + "name": "defaults", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "SupabaseClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 61, + "typeArguments": [ + { + "type": "reference", + "id": 53, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" + } + } + ] + }, + { + "id": 56, + "name": "isBrowser", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 16, + "character": 13 + } + ], + "signatures": [ + { + "id": 57, + "name": "isBrowser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 47, + "name": "stripTrailingSlash", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 12, + "character": 16 + } + ], + "signatures": [ + { + "id": 48, + "name": "stripTrailingSlash", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 49, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 45, + "name": "uuid", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 4, + "character": 16 + } + ], + "signatures": [ + { + "id": 46, + "name": "uuid", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [50, 56, 47, 45] + } + ], + "sources": [ + { + "fileName": "src/lib/helpers.ts", + "line": 2, + "character": 0 + } + ] + }, + { + "id": 58, + "name": "lib/types", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 59, + "name": "SupabaseAuthClientOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 6, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "name": "GoTrueClientOptions" + } + ] + }, + { + "id": 60, + "name": "Fetch", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 8, + "character": 12 + } + ], + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 18, + "qualifiedName": "fetch", + "package": "typescript", + "name": "fetch" + } + } + }, + { + "id": 93, + "name": "GenericFunction", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 95, + "name": "Args", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 96, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [95, 96] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 30 + } + ] + } + } + }, + { + "id": 89, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 90, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 91, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [91] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 38 + } + ] + } + } + }, + { + "id": 97, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 98, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 101, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 93, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 99, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 79, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 100, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 81, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 92, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [101, 99, 100] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 28 + } + ] + } + } + }, + { + "id": 79, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 80, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 82, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 81, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 83, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 59, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [82, 81, 83] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 27 + } + ] + } + } + }, + { + "id": 84, + "name": "GenericUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 85, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 87, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 86, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 88, + "name": "Update", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 65, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [87, 86, 88] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 62, + "character": 35 + } + ] + } + } + }, + { + "id": 92, + "name": "GenericView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 84, + "name": "GenericUpdatableView" + }, + { + "type": "reference", + "id": 89, + "name": "GenericNonUpdatableView" + } + ] + } + }, + { + "id": 61, + "name": "SupabaseClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 78, + "name": "SchemaName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 62, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 66, + "name": "auth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 67, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 68, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Automatically refreshes the token for logged in users." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 22, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 71, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Detect a session from the URL. Used for OAuth login callbacks." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 70, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Whether to persist a logged in session to storage." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 72, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A storage provider. Used to store the logged in session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 38, + "character": 4 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "storage" + }, + "objectType": { + "type": "reference", + "id": 59, + "name": "SupabaseAuthClientOptions" + } + } + }, + { + "id": 69, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional key name used for storing tokens in local storage" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 26, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [68, 71, 70, 72, 69] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 18, + "character": 9 + } + ] + } + } + }, + { + "id": 63, + "name": "db", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 64, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 65, + "name": "schema", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 15, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 78, + "name": "SchemaName" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [65] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 14, + "character": 7 + } + ] + } + } + }, + { + "id": 74, + "name": "global", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 75, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 76, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom `fetch` implementation." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 48, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 60, + "name": "Fetch" + } + }, + { + "id": 77, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional headers for initializing the client." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [76, 77] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 44, + "character": 11 + } + ] + } + } + }, + { + "id": 73, + "name": "realtime", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Options passed to the realtime-js instance" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "RealtimeClientOptions", + "package": "@supabase/realtime-js", + "name": "RealtimeClientOptions" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [66, 63, 74, 73] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 10, + "character": 48 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [59] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [60, 93, 89, 97, 79, 84, 92, 61] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 102, + "name": "lib/version", + "kind": 2, + "kindString": "Module", + "flags": {}, + "children": [ + { + "id": 103, + "name": "version", + "kind": 32, + "kindString": "Variable", + "flags": { + "isConst": true + }, + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 13 + } + ], + "type": { + "type": "literal", + "value": "0.0.0-automated" + }, + "defaultValue": "'0.0.0-automated'" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [103] + } + ], + "sources": [ + { + "fileName": "src/lib/version.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "kind": 2, + "children": [1, 10, 14, 44, 58, 102] + } + ] +} diff --git a/spec/enrichments/tsdoc_v2/supabase_dereferenced.json b/spec/enrichments/tsdoc_v2/supabase_dereferenced.json index fa1f979760b..11f9da9faf0 100644 --- a/spec/enrichments/tsdoc_v2/supabase_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/supabase_dereferenced.json @@ -402,13 +402,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -474,9 +468,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -577,10 +569,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -623,12 +612,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -2080,10 +2064,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 157, - 156 - ] + "children": [157, 156] } ] } @@ -2201,53 +2182,22 @@ { "title": "Constructors", "kind": 512, - "children": [ - 105 - ] + "children": [105] }, { "title": "Properties", "kind": 1024, - "children": [ - 113, - 115, - 126, - 121, - 117, - 127, - 118, - 114, - 119, - 120, - 116, - 132, - 131 - ] + "children": [113, 115, 126, 121, 117, 127, 118, 114, 119, 120, 116, 132, 131] }, { "title": "Accessors", "kind": 262144, - "children": [ - 133, - 135 - ] + "children": [133, 135] }, { "title": "Methods", "kind": 2048, - "children": [ - 169, - 186, - 180, - 171, - 183, - 158, - 137, - 162, - 167, - 164, - 148 - ] + "children": [169, 186, 180, 171, 183, 158, 137, 162, 167, 164, 148] } ], "sources": [ @@ -2742,13 +2692,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -2814,9 +2758,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -2917,10 +2859,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -2963,12 +2902,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -3014,23 +2948,17 @@ { "title": "References", "kind": 16777216, - "children": [ - 194 - ] + "children": [194] }, { "title": "Classes", "kind": 128, - "children": [ - 104 - ] + "children": [104] }, { "title": "Functions", "kind": 64, - "children": [ - 2 - ] + "children": [2] } ], "sources": [ @@ -3096,9 +3024,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 13 - ] + "children": [13] } ] } @@ -3110,9 +3036,7 @@ { "title": "Variables", "kind": 32, - "children": [ - 11 - ] + "children": [11] } ], "sources": [ @@ -3546,11 +3470,7 @@ { "title": "Functions", "kind": 64, - "children": [ - 29, - 15, - 26 - ] + "children": [29, 15, 26] } ], "sources": [ @@ -3851,13 +3771,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -3923,9 +3837,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -4026,10 +3938,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -4072,12 +3981,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -4291,13 +4195,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -4363,9 +4261,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -4466,10 +4362,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -4512,12 +4405,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -4647,12 +4535,7 @@ { "title": "Functions", "kind": 64, - "children": [ - 50, - 56, - 47, - 45 - ] + "children": [50, 56, 47, 45] } ], "sources": [ @@ -4789,10 +4672,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 95, - 96 - ] + "children": [95, 96] } ], "sources": [ @@ -4862,9 +4742,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 91 - ] + "children": [91] } ], "sources": [ @@ -4997,11 +4875,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 101, - 99, - 100 - ] + "children": [101, 99, 100] } ], "sources": [ @@ -5131,11 +5005,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 82, - 81, - 83 - ] + "children": [82, 81, 83] } ], "sources": [ @@ -5265,11 +5135,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 87, - 86, - 88 - ] + "children": [87, 86, 88] } ], "sources": [ @@ -5415,11 +5281,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 87, - 86, - 88 - ] + "children": [87, 86, 88] } ], "sources": [ @@ -5489,9 +5351,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 91 - ] + "children": [91] } ], "sources": [ @@ -5690,13 +5550,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 68, - 71, - 70, - 72, - 69 - ] + "children": [68, 71, 70, 72, 69] } ], "sources": [ @@ -5762,9 +5616,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 65 - ] + "children": [65] } ], "sources": [ @@ -5865,10 +5717,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 76, - 77 - ] + "children": [76, 77] } ], "sources": [ @@ -5911,12 +5760,7 @@ { "title": "Properties", "kind": 1024, - "children": [ - 66, - 63, - 74, - 73 - ] + "children": [66, 63, 74, 73] } ], "sources": [ @@ -5934,23 +5778,12 @@ { "title": "Interfaces", "kind": 256, - "children": [ - 59 - ] + "children": [59] }, { "title": "Type Aliases", "kind": 4194304, - "children": [ - 60, - 93, - 89, - 97, - 79, - 84, - 92, - 61 - ] + "children": [60, 93, 89, 97, 79, 84, 92, 61] } ], "sources": [ @@ -5994,9 +5827,7 @@ { "title": "Variables", "kind": 32, - "children": [ - 103 - ] + "children": [103] } ], "sources": [ @@ -6012,14 +5843,7 @@ { "title": "Modules", "kind": 2, - "children": [ - 1, - 10, - 14, - 44, - 58, - 102 - ] + "children": [1, 10, 14, 44, 58, 102] } ] -} \ No newline at end of file +} diff --git a/spec/transforms/api_v0_openapi_deparsed.json b/spec/transforms/api_v0_openapi_deparsed.json index c402f198446..ab82667dca0 100644 --- a/spec/transforms/api_v0_openapi_deparsed.json +++ b/spec/transforms/api_v0_openapi_deparsed.json @@ -1078,17 +1078,17 @@ "schema": { "type": "object", "properties": { + "max_rows": { + "type": "integer" + }, "db_schema": { "type": "string" }, - "max_rows": { - "type": "number" - }, "db_extra_search_path": { "type": "string" } }, - "required": ["db_schema", "max_rows", "db_extra_search_path"] + "required": ["max_rows", "db_schema", "db_extra_search_path"] } } } @@ -1130,15 +1130,16 @@ "schema": { "type": "object", "properties": { + "max_rows": { + "type": "integer", + "minimum": 0, + "maximum": 1000000 + }, "db_extra_search_path": { "type": "string" }, "db_schema": { "type": "string" - }, - "max_rows": { - "type": "number", - "maximum": 1000000 } } } @@ -1153,17 +1154,17 @@ "schema": { "type": "object", "properties": { + "max_rows": { + "type": "integer" + }, "db_schema": { "type": "string" }, - "max_rows": { - "type": "number" - }, "db_extra_search_path": { "type": "string" } }, - "required": ["db_schema", "max_rows", "db_extra_search_path"] + "required": ["max_rows", "db_schema", "db_extra_search_path"] } } } @@ -2396,30 +2397,31 @@ "PostgrestConfigResponse": { "type": "object", "properties": { + "max_rows": { + "type": "integer" + }, "db_schema": { "type": "string" }, - "max_rows": { - "type": "number" - }, "db_extra_search_path": { "type": "string" } }, - "required": ["db_schema", "max_rows", "db_extra_search_path"] + "required": ["max_rows", "db_schema", "db_extra_search_path"] }, "UpdatePostgrestConfigBody": { "type": "object", "properties": { + "max_rows": { + "type": "integer", + "minimum": 0, + "maximum": 1000000 + }, "db_extra_search_path": { "type": "string" }, "db_schema": { "type": "string" - }, - "max_rows": { - "type": "number", - "maximum": 1000000 } } },