dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 17:35:10 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
cca73571ddca0c5863ca72bbbbe34bcbdbebf043
supabase/web/spec/combined.json
T

42407 lines
1.5 MiB
Plaintext
Raw Blame History

{
"name": "Combined Specs",
"children": [
{
"id": 0,
"name": "@supabase/supabase-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 239,
"name": "\"SupabaseClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/SupabaseClient.ts",
"children": [
{
"id": 240,
"name": "SupabaseClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Supabase Client.",
"text": "An isomorphic Javascript client for interacting with Postgres.\n"
},
"children": [
{
"id": 248,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"signatures": [
{
"id": 251,
"name": "new SupabaseClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 252,
"name": "supabaseUrl",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"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": 253,
"name": "supabaseKey",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"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": 254,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 5,
"name": "SupabaseClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 240,
"name": "SupabaseClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 34,
"character": 36
}
]
},
{
"id": 241,
"name": "auth",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"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": 27,
"character": 6
}
],
"type": {
"type": "reference",
"id": 27,
"name": "SupabaseAuthClient"
}
},
{
"id": 245,
"name": "authUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 32,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 247,
"name": "realtime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 34,
"character": 20
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 244,
"name": "realtimeUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 31,
"character": 23
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 243,
"name": "restUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 30,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 242,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 29,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 246,
"name": "storageUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 33,
"character": 22
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 250,
"name": "supabaseKey",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard."
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 48,
"character": 25
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 249,
"name": "supabaseUrl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard."
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 47,
"character": 25
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 255,
"name": "storage",
"kind": 262144,
"kindString": "Accessor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos."
},
"getSignature": [
{
"id": 256,
"name": "__get",
"kind": 524288,
"kindString": "Get signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos."
},
"type": {
"type": "reference",
"name": "SupabaseStorageClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 73,
"character": 13
}
]
},
{
"id": 291,
"name": "_closeChannel",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 292,
"name": "_closeChannel",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 293,
"name": "subscription",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 178,
"character": 23
}
]
},
{
"id": 269,
"name": "_closeSubscription",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 270,
"name": "_closeSubscription",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 271,
"name": "subscription",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 125,
"character": 34
}
]
},
{
"id": 286,
"name": "_getAuthHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 287,
"name": "_getAuthHeaders",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 288,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 289,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 290,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 170,
"character": 28
}
]
}
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 170,
"character": 25
}
]
},
{
"id": 284,
"name": "_initPostgRESTClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 285,
"name": "_initPostgRESTClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "PostgrestClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 163,
"character": 30
}
]
},
{
"id": 282,
"name": "_initRealtimeClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 283,
"name": "_initRealtimeClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 157,
"character": 29
}
]
},
{
"id": 274,
"name": "_initSupabaseAuthClient",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 275,
"name": "_initSupabaseAuthClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 276,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 278,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 139,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 280,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 141,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 281,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 142,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"name": "Storage"
}
]
}
},
{
"id": 279,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 140,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [278, 280, 281, 279]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 138,
"character": 34
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 27,
"name": "SupabaseAuthClient"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 138,
"character": 33
}
]
},
{
"id": 257,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 258,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a table operation."
},
"typeParameter": [
{
"id": 259,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 260,
"name": "table",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The table name to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 153,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "SupabaseQueryBuilder"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 82,
"character": 6
}
]
},
{
"id": 272,
"name": "getSubscriptions",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 273,
"name": "getSubscriptions",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns an array of all your subscriptions."
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 134,
"character": 18
}
]
},
{
"id": 266,
"name": "removeSubscription",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 267,
"name": "removeSubscription",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes an active subscription and returns the number of open connections."
},
"parameters": [
{
"id": 268,
"name": "subscription",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The subscription you want to remove.\n"
},
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 108,
"character": 20
}
]
},
{
"id": 261,
"name": "rpc",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 262,
"name": "rpc",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a stored procedure call."
},
"typeParameter": [
{
"id": 263,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 264,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The function name to call."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 265,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The parameters to pass to the function call.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "unknown",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 98,
"character": 5
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [248]
},
{
"title": "Properties",
"kind": 1024,
"children": [241, 245, 247, 244, 243, 242, 246, 250, 249]
},
{
"title": "Accessors",
"kind": 262144,
"children": [255]
},
{
"title": "Methods",
"kind": 2048,
"children": [291, 269, 286, 284, 282, 274, 257, 272, 266, 261]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 23,
"character": 35
}
]
},
{
"id": 294,
"name": "DEFAULT_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 296,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 11,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 298,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 13,
"character": 20
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 300,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 15,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 301,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
},
"defaultValue": "DEFAULT_HEADERS"
},
{
"id": 299,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 14,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
},
"defaultValue": "globalThis.localStorage"
},
{
"id": 297,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 12,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 295,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 10,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"public\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [296, 298, 300, 299, 297, 295]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 9,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [240]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [294]
}
],
"sources": [
{
"fileName": "src/SupabaseClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 302,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/index.ts",
"children": [
{
"id": 303,
"name": "createClient",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Creates a new Supabase Client."
},
"signatures": [
{
"id": 304,
"name": "createClient",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Supabase Client."
},
"parameters": [
{
"id": 305,
"name": "supabaseUrl",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 306,
"name": "supabaseKey",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 307,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 5,
"name": "SupabaseClientOptions"
}
}
],
"type": {
"type": "reference",
"id": 240,
"name": "SupabaseClient"
}
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 10,
"character": 18
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [303]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 26,
"name": "\"lib/SupabaseAuthClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseAuthClient.ts",
"children": [
{
"id": 27,
"name": "SupabaseAuthClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 28,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 29,
"name": "new SupabaseAuthClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 30,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 38,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 8,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 37,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 7,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 33,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 6,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 34,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 35,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 36,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 40,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 10,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 39,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 9,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 32,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 5,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [38, 37, 33, 40, 39, 32]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 4,
"character": 22
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 27,
"name": "SupabaseAuthClient"
},
"overwrites": {
"type": "reference",
"name": "GoTrueClient.__constructor"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 3,
"character": 54
}
],
"overwrites": {
"type": "reference",
"name": "GoTrueClient.__constructor"
}
},
{
"id": 41,
"name": "api",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 8,
"character": 7
}
],
"type": {
"type": "reference",
"name": "GoTrueApi"
},
"inheritedFrom": {
"type": "reference",
"id": 41,
"name": "GoTrueClient.api"
}
},
{
"id": 44,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 17,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"id": 44,
"name": "GoTrueClient.autoRefreshToken"
}
},
{
"id": 43,
"name": "currentSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 16,
"character": 28
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 43,
"name": "GoTrueClient.currentSession"
}
},
{
"id": 42,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 12,
"character": 25
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 42,
"name": "GoTrueClient.currentUser"
}
},
{
"id": 46,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 19,
"character": 26
}
],
"type": {
"type": "reference",
"name": "Storage"
},
"inheritedFrom": {
"type": "reference",
"id": 46,
"name": "GoTrueClient.localStorage"
}
},
{
"id": 45,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 18,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"inheritedFrom": {
"type": "reference",
"id": 45,
"name": "GoTrueClient.persistSession"
}
},
{
"id": 48,
"name": "refreshTokenTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 21,
"character": 31
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "query",
"queryType": {
"type": "reference",
"name": "setTimeout"
}
}
],
"name": "ReturnType"
},
"inheritedFrom": {
"type": "reference",
"id": 48,
"name": "GoTrueClient.refreshTokenTimer"
}
},
{
"id": 47,
"name": "stateChangeEmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 20,
"character": 33
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"name": "Subscription"
}
],
"name": "Map"
},
"inheritedFrom": {
"type": "reference",
"id": 47,
"name": "GoTrueClient.stateChangeEmitters"
}
},
{
"id": 107,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 108,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 109,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 110,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 111,
"name": "storeSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Optionally store the session in the browser\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 121,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [111]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 112,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 113,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 123,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 114,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 124,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [113, 114]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 122,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 107,
"name": "GoTrueClient.getSessionFromUrl"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 120,
"character": 21
}
],
"inheritedFrom": {
"type": "reference",
"id": 107,
"name": "GoTrueClient.getSessionFromUrl"
}
},
{
"id": 119,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 120,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Receive a notification every time an auth event happens.",
"returns": "A subscription object which can be used to unsubscribe itself.\n"
},
"parameters": [
{
"id": 121,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 122,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 124,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "AuthChangeEvent"
}
},
{
"id": 125,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 139,
"character": 31
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 126,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 127,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 140,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Subscription"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 128,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 141,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [127, 128]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 139,
"character": 91
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 119,
"name": "GoTrueClient.onAuthStateChange"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 139,
"character": 21
}
],
"inheritedFrom": {
"type": "reference",
"id": 119,
"name": "GoTrueClient.onAuthStateChange"
}
},
{
"id": 85,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 86,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Force refreshes the session including the user data in case it was updated in a different session."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 87,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 88,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 91,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 90,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 93,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 89,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 92,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [88, 90, 89]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 90,
"character": 30
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 85,
"name": "GoTrueClient.refreshSession"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 90,
"character": 18
}
],
"inheritedFrom": {
"type": "reference",
"id": 85,
"name": "GoTrueClient.refreshSession"
}
},
{
"id": 83,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 84,
"name": "session",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the session data, if there is an active session."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 83,
"name": "GoTrueClient.session"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 86,
"character": 11
}
],
"inheritedFrom": {
"type": "reference",
"id": 83,
"name": "GoTrueClient.session"
}
},
{
"id": 104,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 105,
"name": "setAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests."
},
"parameters": [
{
"id": 106,
"name": "access_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "a jwt access token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"name": "Session"
},
"inheritedFrom": {
"type": "reference",
"id": 104,
"name": "GoTrueClient.setAuth"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 115,
"character": 11
}
],
"inheritedFrom": {
"type": "reference",
"id": 104,
"name": "GoTrueClient.setAuth"
}
},
{
"id": 98,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 99,
"name": "setSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sets the session data from refresh_token and returns current Session and Error"
},
"parameters": [
{
"id": 100,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "a JWT token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 101,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 103,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 109,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 102,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 108,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [103, 102]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 107,
"character": 47
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 98,
"name": "GoTrueClient.setSession"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 107,
"character": 14
}
],
"inheritedFrom": {
"type": "reference",
"id": 98,
"name": "GoTrueClient.setSession"
}
},
{
"id": 63,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 64,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 65,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 66,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 67,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 68,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 28
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 69,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "One of the providers supported by GoTrue."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "stringLiteral",
"value": "azure"
},
{
"type": "stringLiteral",
"value": "bitbucket"
},
{
"type": "stringLiteral",
"value": "facebook"
},
{
"type": "stringLiteral",
"value": "github"
},
{
"type": "stringLiteral",
"value": "gitlab"
},
{
"type": "stringLiteral",
"value": "google"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [67, 68, 69]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 11
}
]
}
}
},
{
"id": 70,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 71,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 72,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 67,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 73,
"name": "scopes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 68,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [72, 73]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 74,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 80,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 75,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 79,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 74,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 77,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 72,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Provider"
}
},
{
"id": 75,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 70,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 78,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 73,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 76,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 71,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [80, 79, 77, 75, 78, 76]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 69,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 63,
"name": "GoTrueClient.signIn"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 66,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 63,
"name": "GoTrueClient.signIn"
}
},
{
"id": 115,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 116,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.",
"text": "For server-side management, you can disable sessions by passing a JWT through to `auth.api.signOut(JWT: string)`\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 117,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 118,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 133,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [118]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 132,
"character": 23
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 115,
"name": "GoTrueClient.signOut"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 132,
"character": 11
}
],
"inheritedFrom": {
"type": "reference",
"id": 115,
"name": "GoTrueClient.signOut"
}
},
{
"id": 49,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 50,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 51,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 52,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 53,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 49,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 54,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 49,
"character": 28
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [53, 54]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 49,
"character": 11
}
]
}
}
},
{
"id": 55,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 56,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 57,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 50,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [57]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 58,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 62,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 55,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 61,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 54,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 60,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 53,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 59,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 52,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [62, 61, 60, 59]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 51,
"character": 16
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 49,
"name": "GoTrueClient.signUp"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 49,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 49,
"name": "GoTrueClient.signUp"
}
},
{
"id": 91,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 92,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 93,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 94,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 95,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 99,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 97,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 101,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 96,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 100,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [95, 97, 96]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 98,
"character": 48
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 91,
"name": "GoTrueClient.update"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 98,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 91,
"name": "GoTrueClient.update"
}
},
{
"id": 81,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 82,
"name": "user",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Inside a browser context, `user()` will return the user data, if there is a logged in user.",
"text": "For server-side management, you can get a user through `auth.api.getUserByCookie()`\n"
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 81,
"name": "GoTrueClient.user"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts",
"line": 82,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 81,
"name": "GoTrueClient.user"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [28]
},
{
"title": "Properties",
"kind": 1024,
"children": [41, 44, 43, 42, 46, 45, 48, 47]
},
{
"title": "Methods",
"kind": 2048,
"children": [107, 119, 85, 83, 104, 98, 63, 115, 49, 91, 81]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 3,
"character": 31
}
],
"extendedTypes": [
{
"type": "reference",
"name": "GoTrueClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [27]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseAuthClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 152,
"name": "\"lib/SupabaseQueryBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseQueryBuilder.ts",
"children": [
{
"id": 153,
"name": "SupabaseQueryBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 154,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 157,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 158,
"name": "new SupabaseQueryBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 159,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 160,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 161,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 162,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 13,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 163,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 164,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 165,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 167,
"name": "realtime",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 166,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 168,
"name": "table",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 16,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [162, 167, 166, 168]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 11,
"character": 16
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 153,
"name": "SupabaseQueryBuilder"
},
"overwrites": {
"type": "reference",
"name": "PostgrestQueryBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 8,
"character": 35
}
],
"overwrites": {
"type": "reference",
"name": "PostgrestQueryBuilder.__constructor"
}
},
{
"id": 156,
"name": "_realtime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPrivate": true,
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 8,
"character": 19
}
],
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 155,
"name": "_subscription",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPrivate": true,
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 7,
"character": 23
}
],
"type": {
"type": "reference",
"id": 130,
"name": "SupabaseRealtimeClient"
}
},
{
"id": 226,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 47,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 226,
"name": "PostgrestBuilder.body"
}
},
{
"id": 221,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 43,
"character": 21
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 222,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 223,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 224,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 43,
"character": 22
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 221,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 219,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 41,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 219,
"name": "PostgrestBuilder.method"
}
},
{
"id": 225,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 46,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 225,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 220,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 42,
"character": 17
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 220,
"name": "PostgrestBuilder.url"
}
},
{
"id": 213,
"name": "delete",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 214,
"name": "delete",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs a DELETE on the table."
},
"parameters": [
{
"id": 215,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 216,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 218,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 71,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 217,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, return the deleted row(s) in the response."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 71,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [218, 217]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 71,
"character": 11
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 213,
"name": "PostgrestQueryBuilder.delete"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 71,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 213,
"name": "PostgrestQueryBuilder.delete"
}
},
{
"id": 183,
"name": "insert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 184,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an INSERT into the table."
},
"parameters": [
{
"id": 185,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 186,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 187,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 189,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 30,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 188,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 29,
"character": 17
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [189, 188]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 183,
"name": "PostgrestQueryBuilder.insert"
}
},
{
"id": 190,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `upsert()` instead.\n"
}
]
},
"parameters": [
{
"id": 191,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 192,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 193,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 197,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 39,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 195,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 37,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 196,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 38,
"character": 17
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
},
{
"id": 194,
"name": "upsert",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 36,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [197, 195, 196, 194]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 183,
"name": "PostgrestQueryBuilder.insert"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 28,
"character": 10
},
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 35,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 183,
"name": "PostgrestQueryBuilder.insert"
}
},
{
"id": 169,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 170,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Subscribe to realtime changes in your databse."
},
"parameters": [
{
"id": 171,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The database event which you would like to receive updates for, or you can use the special wildcard `*` to listen to all changes."
},
"type": {
"type": "reference",
"id": 25,
"name": "SupabaseEventTypes"
}
},
{
"id": 172,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A callback that will handle the payload that is sent whenever your database changes.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 173,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 174,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 175,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 16,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "SupabaseRealtimePayload"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 37,
"character": 13
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 130,
"name": "SupabaseRealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 35,
"character": 4
}
]
},
{
"id": 176,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 177,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs vertical filtering with SELECT."
},
"parameters": [
{
"id": 178,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The columns to retrieve, separated by commas."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 179,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 180,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 182,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 17,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 181,
"name": "head",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "When set to true, select will void data."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 17,
"character": 35
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [182, 181]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 17,
"character": 28
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 176,
"name": "PostgrestQueryBuilder.select"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 17,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 176,
"name": "PostgrestQueryBuilder.select"
}
},
{
"id": 227,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 228,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 229,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 230,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 231,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 232,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 233,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 234,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 49,
"character": 75
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 235,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 237,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 238,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 49,
"character": 176
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 227,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts",
"line": 49,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 227,
"name": "PostgrestBuilder.then"
}
},
{
"id": 206,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 207,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPDATE on the table."
},
"parameters": [
{
"id": 208,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to update."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
},
{
"id": 209,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 210,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 212,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 61,
"character": 49
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 211,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By default the updated record is returned. Set this to 'minimal' if you don't need this value."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 61,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [212, 211]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 61,
"character": 30
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 206,
"name": "PostgrestQueryBuilder.update"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 61,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 206,
"name": "PostgrestQueryBuilder.update"
}
},
{
"id": 198,
"name": "upsert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 199,
"name": "upsert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPSERT into the table."
},
"parameters": [
{
"id": 200,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 201,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 202,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 205,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 49,
"character": 76
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 203,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 49,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 204,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By default the new record is returned. Set this to 'minimal' if you don't need this value."
},
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 49,
"character": 69
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [205, 203, 204]
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 49,
"character": 45
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 198,
"name": "PostgrestQueryBuilder.upsert"
}
}
],
"sources": [
{
"fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts",
"line": 49,
"character": 10
}
],
"inheritedFrom": {
"type": "reference",
"id": 198,
"name": "PostgrestQueryBuilder.upsert"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [157]
},
{
"title": "Properties",
"kind": 1024,
"children": [156, 155, 226, 221, 219, 225, 220]
},
{
"title": "Methods",
"kind": 2048,
"children": [213, 183, 169, 176, 227, 206, 198]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 6,
"character": 33
}
],
"extendedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestQueryBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [153]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseQueryBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 129,
"name": "\"lib/SupabaseRealtimeClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseRealtimeClient.ts",
"children": [
{
"id": 130,
"name": "SupabaseRealtimeClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 132,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 133,
"name": "new SupabaseRealtimeClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 134,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "RealtimeClient"
}
},
{
"id": 135,
"name": "schema",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 136,
"name": "tableName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 130,
"name": "SupabaseRealtimeClient"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 5,
"character": 36
}
]
},
{
"id": 131,
"name": "subscription",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 5,
"character": 14
}
],
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
},
{
"id": 137,
"name": "getPayloadRecords",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 138,
"name": "getPayloadRecords",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 139,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 140,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 141,
"name": "new",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 14,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 142,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
},
{
"id": 143,
"name": "old",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 15,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 144,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [141, 143]
}
]
}
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 12,
"character": 27
}
]
},
{
"id": 145,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 146,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The event you want to listen to."
},
"parameters": [
{
"id": 147,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The event"
},
"type": {
"type": "reference",
"id": 25,
"name": "SupabaseEventTypes"
}
},
{
"id": 148,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A callback function that is called whenever the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 35,
"character": 4
}
]
},
{
"id": 149,
"name": "subscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 150,
"name": "subscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Enables the subscription."
},
"parameters": [
{
"id": 151,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
},
"defaultValue": "() => {}"
}
],
"type": {
"type": "reference",
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 56,
"character": 11
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [132]
},
{
"title": "Properties",
"kind": 1024,
"children": [131]
},
{
"title": "Methods",
"kind": 2048,
"children": [137, 145, 149]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 4,
"character": 35
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [130]
}
],
"sources": [
{
"fileName": "src/lib/SupabaseRealtimeClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/constants.ts",
"children": [
{
"id": 2,
"name": "DEFAULT_HEADERS",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "src/lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 3,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [2]
}
],
"sources": [
{
"fileName": "src/lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 308,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/helpers.ts",
"children": [
{
"id": 309,
"name": "uuid",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 310,
"name": "uuid",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "src/lib/helpers.ts",
"line": 3,
"character": 20
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [309]
}
],
"sources": [
{
"fileName": "src/lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 4,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/types.ts",
"children": [
{
"id": 5,
"name": "SupabaseClientOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 33
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 6,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 12,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 13,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 14,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 21,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 8,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Optional headers for initializing the client."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 9,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 9,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 10,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 11,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 15,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 13,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 17,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 7,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"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": 5,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [12, 14, 8, 15, 13, 7]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 35
}
]
}
}
},
{
"id": 25,
"name": "SupabaseEventTypes",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 39,
"character": 30
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "INSERT"
},
{
"type": "stringLiteral",
"value": "UPDATE"
},
{
"type": "stringLiteral",
"value": "DELETE"
},
{
"type": "stringLiteral",
"value": "*"
}
]
}
},
{
"id": 16,
"name": "SupabaseRealtimePayload",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 17,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 35
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 18,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 19,
"name": "commit_timestamp",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 20,
"name": "eventType",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 30,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "INSERT"
},
{
"type": "stringLiteral",
"value": "UPDATE"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 23,
"name": "new",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The new record. Present for 'INSERT' and 'UPDATE' events."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 34,
"character": 5
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 24,
"name": "old",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The previous record. Present for 'UPDATE' and 'DELETE' events."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 36,
"character": 5
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 21,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 31,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 22,
"name": "table",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 32,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [19, 20, 23, 24, 21, 22]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 28,
"character": 40
}
]
}
}
}
],
"groups": [
{
"title": "Type aliases",
"kind": 4194304,
"children": [5, 25, 16]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [239, 302, 26, 152, 129, 1, 308, 4]
}
]
},
{
"id": 0,
"name": "@supabase/gotrue-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 196,
"name": "\"GoTrueApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueApi.ts",
"children": [
{
"id": 197,
"name": "GoTrueApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 204,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 205,
"name": "new GoTrueApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 206,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 207,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 213,
"name": "cookieOptions",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 17,
"character": 17
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reference",
"id": 92,
"name": "CookieOptions"
}
]
}
},
{
"id": 209,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 16,
"character": 11
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 210,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 211,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 212,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 208,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 15,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [213, 209, 208]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 14,
"character": 14
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 197,
"name": "GoTrueApi"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 12,
"character": 40
}
]
},
{
"id": 203,
"name": "cookieOptions",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 12,
"character": 25
}
],
"type": {
"type": "reference",
"id": 92,
"name": "CookieOptions"
}
},
{
"id": 199,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 9,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 200,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 201,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 202,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 9,
"character": 20
}
]
}
}
},
{
"id": 198,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 8,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 264,
"name": "_createRequestHeaders",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 265,
"name": "_createRequestHeaders",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods"
},
"parameters": [
{
"id": 266,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 267,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 165,
"character": 31
}
]
},
{
"id": 295,
"name": "deleteUser",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 296,
"name": "deleteUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Delete an user."
},
"parameters": [
{
"id": 297,
"name": "uid",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The user uid you want to remove."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 298,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid JWT. Must be a full-access API key (e.g. service_role key).\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 299,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 301,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 253,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 302,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 253,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 300,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 253,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [301, 302, 300]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 253,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 250,
"character": 18
}
]
},
{
"id": 273,
"name": "getUrlForProvider",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 274,
"name": "getUrlForProvider",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Generates the relevant login URL for a third-party provider."
},
"parameters": [
{
"id": 275,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "One of the providers supported by GoTrue."
},
"type": {
"type": "reference",
"id": 102,
"name": "Provider"
}
},
{
"id": 276,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 278,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 197,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 279,
"name": "scopes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 198,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [278, 279]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 196,
"character": 12
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 194,
"character": 19
}
]
},
{
"id": 280,
"name": "getUser",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 281,
"name": "getUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the user details."
},
"parameters": [
{
"id": 282,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 283,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 285,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 217,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 286,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 217,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 284,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 217,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [285, 286, 284]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 217,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 215,
"character": 15
}
]
},
{
"id": 313,
"name": "getUserByCookie",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 314,
"name": "getUserByCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)."
},
"parameters": [
{
"id": 315,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 316,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 318,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 321,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 319,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 321,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 317,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 321,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [318, 319, 317]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 321,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 319,
"character": 23
}
]
},
{
"id": 244,
"name": "inviteUserByEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 245,
"name": "inviteUserByEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sends an invite link to an email address."
},
"parameters": [
{
"id": 246,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 247,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 248,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 249,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 122,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [249]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 121,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 250,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 251,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 252,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 253,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [251, 253]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 124,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 119,
"character": 25
}
]
},
{
"id": 303,
"name": "refreshAccessToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 304,
"name": "refreshAccessToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Generates a new JWT."
},
"parameters": [
{
"id": 305,
"name": "refreshToken",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid refresh token that was returned on login.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 306,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 307,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 274,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 308,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 274,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [307, 308]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 274,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 272,
"character": 26
}
]
},
{
"id": 254,
"name": "resetPasswordForEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 255,
"name": "resetPasswordForEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sends a reset request to an email address."
},
"parameters": [
{
"id": 256,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 257,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 258,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 259,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 145,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [259]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 144,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 260,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 261,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 147,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 147,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 263,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 147,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [261, 263]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 147,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 142,
"character": 29
}
]
},
{
"id": 234,
"name": "sendMagicLinkEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 235,
"name": "sendMagicLinkEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sends a magic login link to an email address."
},
"parameters": [
{
"id": 236,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 237,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 238,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 239,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 99,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [239]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 98,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 240,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 241,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 101,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 242,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 101,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 243,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 101,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [241, 243]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 101,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 96,
"character": 26
}
]
},
{
"id": 309,
"name": "setAuthCookie",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 310,
"name": "setAuthCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Set/delete the auth cookie based on the AuthChangeEvent.\nWorks for Next.js & Express (requires cookie-parser middleware)."
},
"parameters": [
{
"id": 311,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 312,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 293,
"character": 15
}
]
},
{
"id": 224,
"name": "signInWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 225,
"name": "signInWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Logs in an existing user using their email address."
},
"parameters": [
{
"id": 226,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 227,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 228,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 229,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 230,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 70,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [230]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 69,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 231,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 232,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 72,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 233,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 72,
"character": 42
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [232, 233]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 72,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 66,
"character": 23
}
]
},
{
"id": 268,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 269,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes a logged-in session."
},
"parameters": [
{
"id": 270,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 271,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 272,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 175,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [272]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 175,
"character": 38
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 175,
"character": 15
}
]
},
{
"id": 214,
"name": "signUpWithEmail",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 215,
"name": "signUpWithEmail",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user using their email address.",
"returns": "A logged-in session if the server has \"autoconfirm\" ON"
},
"parameters": [
{
"id": 216,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The email address of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 217,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The password of the user."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 218,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 219,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 220,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 43,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [220]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 42,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 221,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 222,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 45,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 223,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 45,
"character": 49
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [222, 223]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 45,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 39,
"character": 23
}
]
},
{
"id": 287,
"name": "updateUser",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 288,
"name": "updateUser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates the user data."
},
"parameters": [
{
"id": 289,
"name": "jwt",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A valid, logged-in JWT."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 290,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The data you want to update.\n"
},
"type": {
"type": "reference",
"id": 77,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 291,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 293,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 234,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 294,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 234,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 292,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 234,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [293, 294, 292]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 234,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 231,
"character": 18
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [204]
},
{
"title": "Properties",
"kind": 1024,
"children": [203, 199, 198]
},
{
"title": "Methods",
"kind": 2048,
"children": [264, 295, 273, 280, 313, 244, 303, 254, 234, 309, 224, 268, 214, 287]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 7,
"character": 30
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [197]
}
],
"sources": [
{
"fileName": "GoTrueApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 323,
"name": "\"GoTrueClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueClient.ts",
"children": [
{
"id": 324,
"name": "GoTrueClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 333,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"signatures": [
{
"id": 334,
"name": "new GoTrueClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create a new client for use in the browser."
},
"parameters": [
{
"id": 335,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 336,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 343,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically refresh the token before expiring."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 60,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 346,
"name": "cookieOptions",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 63,
"character": 17
}
],
"type": {
"type": "reference",
"id": 92,
"name": "CookieOptions"
}
},
{
"id": 342,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 59,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 338,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Any additional headers to send to the GoTrue server."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 58,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 339,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 340,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 341,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 345,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 62,
"character": 16
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 344,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Set to \"true\" if you want to automatically save the user session into local storage."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 61,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
},
{
"id": 337,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The URL of the GoTrue server."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 57,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [343, 346, 342, 338, 345, 344, 337]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 56,
"character": 22
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 324,
"name": "GoTrueClient"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 45,
"character": 61
}
]
},
{
"id": 325,
"name": "api",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 31,
"character": 5
}
],
"type": {
"type": "reference",
"id": 197,
"name": "GoTrueApi"
}
},
{
"id": 328,
"name": "autoRefreshToken",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 41,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 327,
"name": "currentSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The session object for the currently logged in user or null."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 39,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 326,
"name": "currentUser",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"comment": {
"shortText": "The currently logged in user or null."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 35,
"character": 23
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 330,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 43,
"character": 24
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 329,
"name": "persistSession",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 42,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 332,
"name": "refreshTokenTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 45,
"character": 29
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "query",
"queryType": {
"type": "reference",
"name": "setTimeout"
}
}
],
"name": "ReturnType"
}
},
{
"id": 331,
"name": "stateChangeEmitters",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 44,
"character": 31
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"id": 82,
"name": "Subscription"
}
],
"name": "Map"
},
"defaultValue": "new Map()"
},
{
"id": 467,
"name": "_callRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 468,
"name": "_callRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 469,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"defaultValue": "this.currentSession?.refresh_token"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 470,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 471,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 519,
"character": 19
}
],
"type": {
"type": "reference",
"id": 50,
"name": "Session"
}
},
{
"id": 472,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 519,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [471, 472]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 473,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 474,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 521,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 475,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 521,
"character": 32
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [474, 475]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 507,
"character": 33
}
]
},
{
"id": 427,
"name": "_handleEmailSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 428,
"name": "_handleEmailSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 429,
"name": "email",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 430,
"name": "password",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 431,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 432,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 433,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 398,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [433]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 397,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 434,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 435,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 412,
"character": 19
}
],
"type": {
"type": "reference",
"id": 50,
"name": "Session"
}
},
{
"id": 438,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 412,
"character": 58
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 437,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 412,
"character": 45
}
],
"type": {
"type": "reference",
"id": 50,
"name": "Session"
},
"defaultValue": "data"
},
{
"id": 436,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 412,
"character": 25
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "reference",
"id": 58,
"name": "User"
}
]
},
"defaultValue": "data.user"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [435, 438, 437, 436]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 439,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 440,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 414,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 443,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 414,
"character": 59
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 442,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 414,
"character": 46
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 441,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 414,
"character": 31
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [440, 443, 442, 441]
}
]
}
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 394,
"character": 34
}
]
},
{
"id": 444,
"name": "_handleProviderSignIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 445,
"name": "_handleProviderSignIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 446,
"name": "provider",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 102,
"name": "Provider"
}
},
{
"id": 447,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 448,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 449,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 421,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 450,
"name": "scopes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 422,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [449, 450]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 420,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 451,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 454,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 34
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 457,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 74
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 452,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 23
}
],
"type": {
"type": "reference",
"id": 102,
"name": "Provider"
}
},
{
"id": 455,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 49
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 453,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 456,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 435,
"character": 61
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [454, 457, 452, 455, 453, 456]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 458,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 459,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 439,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 462,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 439,
"character": 59
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 461,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 439,
"character": 46
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
},
{
"id": 460,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 439,
"character": 31
}
],
"type": {
"type": "intrinsic",
"name": "null"
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [459, 462, 461, 460]
}
]
}
}
]
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 418,
"character": 31
}
]
},
{
"id": 476,
"name": "_notifyAllSubscribers",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 477,
"name": "_notifyAllSubscribers",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 478,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 103,
"name": "AuthChangeEvent"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 525,
"character": 31
}
]
},
{
"id": 482,
"name": "_persistSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 483,
"name": "_persistSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 484,
"name": "currentSession",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 50,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 548,
"character": 25
}
]
},
{
"id": 465,
"name": "_recoverAndRefresh",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 466,
"name": "_recoverAndRefresh",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 471,
"character": 34
}
]
},
{
"id": 463,
"name": "_recoverSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 464,
"name": "_recoverSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Attempts to get the session from LocalStorage\nNote: this should never be async (even for React Native), as we need it to return immediately in the constructor."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 447,
"character": 25
}
]
},
{
"id": 485,
"name": "_removeSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 486,
"name": "_removeSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 553,
"character": 30
}
]
},
{
"id": 479,
"name": "_saveSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 480,
"name": "_saveSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible"
},
"parameters": [
{
"id": 481,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 50,
"name": "Session"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 533,
"character": 22
}
]
},
{
"id": 487,
"name": "_startAutoRefreshToken",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 488,
"name": "_startAutoRefreshToken",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Clear and re-create refresh token timer"
},
"parameters": [
{
"id": 489,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "time intervals in milliseconds\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 564,
"character": 32
}
]
},
{
"id": 405,
"name": "getSessionFromUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 406,
"name": "getSessionFromUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Gets the session data from a URL string"
},
"parameters": [
{
"id": 407,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 408,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 409,
"name": "storeSession",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Optionally store the session in the browser\n"
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 304,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [409]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 410,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 411,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 412,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 43
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [411, 412]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 305,
"character": 14
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 303,
"character": 25
}
]
},
{
"id": 417,
"name": "onAuthStateChange",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 418,
"name": "onAuthStateChange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Receive a notification every time an auth event happens.",
"returns": "A subscription object which can be used to unsubscribe itself.\n"
},
"parameters": [
{
"id": 419,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 420,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 421,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 422,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 103,
"name": "AuthChangeEvent"
}
},
{
"id": 423,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 375,
"character": 13
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 424,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 425,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 376,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 82,
"name": "Subscription"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 426,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 376,
"character": 39
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [425, 426]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 376,
"character": 4
}
]
}
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 374,
"character": 19
}
]
},
{
"id": 383,
"name": "refreshSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 384,
"name": "refreshSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Force refreshes the session including the user data in case it was updated in a different session."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 385,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 386,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 211,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 388,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 213,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 387,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 212,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [386, 388, 387]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 210,
"character": 34
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 210,
"character": 22
}
]
},
{
"id": 381,
"name": "session",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 382,
"name": "session",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the session data, if there is an active session."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 203,
"character": 9
}
]
},
{
"id": 402,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 403,
"name": "setAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests."
},
"parameters": [
{
"id": 404,
"name": "access_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "a jwt access token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 50,
"name": "Session"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 288,
"character": 9
}
]
},
{
"id": 396,
"name": "setSession",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 397,
"name": "setSession",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Sets the session data from refresh_token and returns current Session and Error"
},
"parameters": [
{
"id": 398,
"name": "refresh_token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "a JWT token\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 399,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 401,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 260,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 400,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 260,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [401, 400]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 260,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 258,
"character": 18
}
]
},
{
"id": 361,
"name": "signIn",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 362,
"name": "signIn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Log in an existing user, or login via a third-party provider."
},
"parameters": [
{
"id": 363,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 364,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 365,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 152,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 366,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 152,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 367,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "One of the providers supported by GoTrue."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 152,
"character": 31
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "stringLiteral",
"value": "azure"
},
{
"type": "stringLiteral",
"value": "bitbucket"
},
{
"type": "stringLiteral",
"value": "facebook"
},
{
"type": "stringLiteral",
"value": "github"
},
{
"type": "stringLiteral",
"value": "gitlab"
},
{
"type": "stringLiteral",
"value": "google"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [365, 366, 367]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 151,
"character": 15
}
]
}
}
},
{
"id": 368,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 369,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 370,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 154,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 371,
"name": "scopes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 155,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [370, 371]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 153,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 372,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 378,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 163,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 377,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 162,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 375,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 160,
"character": 12
}
],
"type": {
"type": "reference",
"id": 102,
"name": "Provider"
}
},
{
"id": 373,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 158,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 376,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 161,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 374,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 159,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [378, 377, 375, 373, 376, 374]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 157,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 151,
"character": 14
}
]
},
{
"id": 413,
"name": "signOut",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 414,
"name": "signOut",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.",
"text": "For server-side management, you can disable sessions by passing a JWT through to `auth.api.signOut(JWT: string)`\n"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 415,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 416,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 359,
"character": 34
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [416]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 359,
"character": 27
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 359,
"character": 15
}
]
},
{
"id": 347,
"name": "signUp",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 348,
"name": "signUp",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new user."
},
"parameters": [
{
"id": 349,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 350,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 351,
"name": "email",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's email address."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 97,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 352,
"name": "password",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The user's password."
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 97,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [351, 352]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 96,
"character": 15
}
]
}
}
},
{
"id": 353,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 354,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 355,
"name": "redirectTo",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 99,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [355]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 98,
"character": 12
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 356,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 360,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 105,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 359,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 104,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 358,
"name": "session",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 103,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 357,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 102,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [360, 359, 358, 357]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 101,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 96,
"character": 14
}
]
},
{
"id": 389,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 390,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Updates user data, if there is a logged in user."
},
"parameters": [
{
"id": 391,
"name": "attributes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 77,
"name": "UserAttributes"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 392,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 393,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 233,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 395,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 233,
"character": 58
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 394,
"name": "user",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 233,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [393, 395, 394]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 233,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 231,
"character": 14
}
]
},
{
"id": 379,
"name": "user",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 380,
"name": "user",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Inside a browser context, `user()` will return the user data, if there is a logged in user.",
"text": "For server-side management, you can get a user through `auth.api.getUserByCookie()`\n"
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 196,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [333]
},
{
"title": "Properties",
"kind": 1024,
"children": [325, 328, 327, 326, 330, 329, 332, 331]
},
{
"title": "Methods",
"kind": 2048,
"children": [
467, 427, 444, 476, 482, 465, 463, 485, 479, 487, 405, 417, 383, 381, 402, 396,
361, 413, 347, 389, 379
]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 26,
"character": 33
}
]
},
{
"id": 490,
"name": "DEFAULT_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 492,
"name": "autoRefreshToken",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 20,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 495,
"name": "detectSessionInUrl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 23,
"character": 20
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 496,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 24,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 497,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {}
}
},
"defaultValue": "DEFAULT_HEADERS"
},
{
"id": 494,
"name": "localStorage",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 22,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
},
"defaultValue": "globalThis.localStorage"
},
{
"id": 493,
"name": "persistSession",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 21,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 491,
"name": "url",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 19,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "GOTRUE_URL"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [492, 495, 496, 494, 493, 491]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 18,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [324]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [490]
}
],
"sources": [
{
"fileName": "GoTrueClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 498,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/index.ts",
"children": [
{
"id": 500,
"name": "AuthChangeEvent",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 103
},
{
"id": 505,
"name": "CookieOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 92
},
{
"id": 499,
"name": "Provider",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 102
},
{
"id": 501,
"name": "Session",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 50
},
{
"id": 504,
"name": "Subscription",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 82
},
{
"id": 502,
"name": "User",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 58
},
{
"id": 503,
"name": "UserAttributes",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 77
},
{
"id": 506,
"name": "UserCredentials",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 98
}
],
"groups": [
{
"title": "References",
"kind": 16777216,
"children": [500, 505, 499, 501, 504, 502, 503, 506]
}
],
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 104,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/constants.ts",
"children": [
{
"id": 106,
"name": "AUDIENCE",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 2,
"character": 21
}
],
"type": {
"type": "stringLiteral",
"value": ""
},
"defaultValue": "\"\""
},
{
"id": 107,
"name": "DEFAULT_HEADERS",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
}
},
{
"id": 109,
"name": "EXPIRY_MARGIN",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 4,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "60 * 1000"
},
{
"id": 105,
"name": "GOTRUE_URL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 23
}
],
"type": {
"type": "stringLiteral",
"value": "http://localhost:9999"
},
"defaultValue": "\"http://localhost:9999\""
},
{
"id": 110,
"name": "STORAGE_KEY",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 5,
"character": 24
}
],
"type": {
"type": "stringLiteral",
"value": "supabase.auth.token"
},
"defaultValue": "\"supabase.auth.token\""
},
{
"id": 111,
"name": "COOKIE_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isExported": true,
"isConst": true
},
"children": [
{
"id": 114,
"name": "domain",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 9,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
},
{
"id": 113,
"name": "lifetime",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 8,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "60 * 60 * 8"
},
{
"id": 112,
"name": "name",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 7,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"sb:token\""
},
{
"id": 115,
"name": "path",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 10,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"/\""
},
{
"id": 116,
"name": "sameSite",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 11,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"lax\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [114, 113, 112, 115, 116]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 6,
"character": 27
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [106, 107, 109, 105, 110]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [111]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 117,
"name": "\"lib/cookies\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/cookies.ts",
"children": [
{
"id": 118,
"name": "Cookie",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 1,
"character": 11
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 119,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 123,
"name": "domain",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 5,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 122,
"name": "maxAge",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 4,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 120,
"name": "name",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 2,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 124,
"name": "path",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 6,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 125,
"name": "sameSite",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 7,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 121,
"name": "value",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 3,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [123, 122, 120, 124, 125, 121]
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 1,
"character": 13
}
]
}
}
},
{
"id": 156,
"name": "deleteCookie",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 157,
"name": "deleteCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 158,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 159,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 160,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 164,
"character": 28
}
]
},
{
"id": 139,
"name": "isSecureEnvironment",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 140,
"name": "isSecureEnvironment",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Based on the environment and the request we know if a secure cookie can be set."
},
"parameters": [
{
"id": 141,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 112,
"character": 28
}
]
},
{
"id": 126,
"name": "serialize",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 127,
"name": "serialize",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Serialize data into a cookie header."
},
"parameters": [
{
"id": 128,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 129,
"name": "val",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 130,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 131,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 133,
"name": "domain",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 18,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 135,
"name": "expires",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 20,
"character": 11
}
],
"type": {
"type": "reference",
"name": "Date"
}
},
{
"id": 136,
"name": "httpOnly",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 21,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 132,
"name": "maxAge",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 17,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 134,
"name": "path",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 19,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 138,
"name": "sameSite",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 23,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 137,
"name": "secure",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 22,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [133, 135, 136, 132, 134, 138, 137]
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 16,
"character": 10
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 13,
"character": 18
}
]
},
{
"id": 142,
"name": "serializeCookie",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 143,
"name": "serializeCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Serialize a cookie to a string."
},
"parameters": [
{
"id": 144,
"name": "cookie",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 118,
"name": "Cookie"
}
},
{
"id": 145,
"name": "secure",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 129,
"character": 24
}
]
},
{
"id": 151,
"name": "setCookie",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 152,
"name": "setCookie",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Set one or more cookies."
},
"parameters": [
{
"id": 153,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 154,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 155,
"name": "cookie",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 118,
"name": "Cookie"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 160,
"character": 25
}
]
},
{
"id": 146,
"name": "setCookies",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 147,
"name": "setCookies",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Set one or more cookies."
},
"parameters": [
{
"id": 148,
"name": "req",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 149,
"name": "res",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 150,
"name": "cookies",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 118,
"name": "Cookie"
}
],
"name": "Array"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 144,
"character": 26
}
]
}
],
"groups": [
{
"title": "Type aliases",
"kind": 4194304,
"children": [118]
},
{
"title": "Functions",
"kind": 64,
"children": [156, 139, 126, 142, 151, 146]
}
],
"sources": [
{
"fileName": "lib/cookies.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/fetch\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/fetch.ts",
"children": [
{
"id": 2,
"name": "FetchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 3,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 4,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 4,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 5,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 6,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 7,
"name": "noResolveJson",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 7,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [3, 7]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 3,
"character": 29
}
]
},
{
"id": 8,
"name": "RequestMethodType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 10,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PUT"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 9,
"name": "_getErrorMessage",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 10,
"name": "_getErrorMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 11,
"name": "err",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 12,
"character": 22
}
]
},
{
"id": 16,
"name": "_getRequestParams",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 17,
"name": "_getRequestParams",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 18,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 8,
"name": "RequestMethodType"
}
},
{
"id": 19,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 20,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 21,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 22,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 23,
"name": "k",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 27,
"character": 23
}
]
},
{
"id": 24,
"name": "_handleRequest",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 25,
"name": "_handleRequest",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 26,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 8,
"name": "RequestMethodType"
}
},
{
"id": 27,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 28,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 29,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 40,
"character": 29
}
]
},
{
"id": 30,
"name": "get",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 31,
"name": "get",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 32,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 33,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 58,
"character": 25
}
]
},
{
"id": 12,
"name": "handleError",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 13,
"name": "handleError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 14,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 15,
"name": "reject",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 15,
"character": 17
}
]
},
{
"id": 34,
"name": "post",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "post",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 36,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 37,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 38,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 62,
"character": 26
}
]
},
{
"id": 39,
"name": "put",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 40,
"name": "put",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 41,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 42,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 43,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 66,
"character": 25
}
]
},
{
"id": 44,
"name": "remove",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 45,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 46,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 47,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 48,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 70,
"character": 28
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [2]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [8]
},
{
"title": "Functions",
"kind": 64,
"children": [9, 16, 24, 30, 12, 34, 39, 44]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 161,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/helpers.ts",
"children": [
{
"id": 162,
"name": "LocalStorage",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 164,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 165,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"children": [
{
"id": 167,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 168,
"name": "new LocalStorage",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 169,
"name": "localStorage",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Storage"
}
}
],
"type": {
"type": "reference",
"id": 162,
"name": "LocalStorage"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 29,
"character": 17
}
]
},
{
"id": 166,
"name": "length",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 29,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 163,
"name": "localStorage",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 27,
"character": 14
}
],
"type": {
"type": "reference",
"name": "Storage"
}
},
{
"id": 170,
"name": "clear",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 171,
"name": "clear",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 33,
"character": 7
}
]
},
{
"id": 179,
"name": "getItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 180,
"name": "getItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 181,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 42,
"character": 9
}
]
},
{
"id": 172,
"name": "key",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 173,
"name": "key",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 174,
"name": "index",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 36,
"character": 5
}
]
},
{
"id": 182,
"name": "removeItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 183,
"name": "removeItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 184,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 45,
"character": 12
}
]
},
{
"id": 175,
"name": "setItem",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 176,
"name": "setItem",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 177,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 178,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 39,
"character": 9
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [167]
},
{
"title": "Properties",
"kind": 1024,
"children": [166, 163]
},
{
"title": "Methods",
"kind": 2048,
"children": [170, 179, 172, 182, 175]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 26,
"character": 25
}
],
"implementedTypes": [
{
"type": "reference",
"name": "Storage"
}
]
},
{
"id": 185,
"name": "expiresAt",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 186,
"name": "expiresAt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 187,
"name": "expiresIn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 25
}
]
},
{
"id": 192,
"name": "getParameterByName",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 193,
"name": "getParameterByName",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 194,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 195,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 16,
"character": 34
}
]
},
{
"id": 190,
"name": "isBrowser",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 191,
"name": "isBrowser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 14,
"character": 22
}
]
},
{
"id": 188,
"name": "uuid",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 189,
"name": "uuid",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 6,
"character": 20
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [162]
},
{
"title": "Functions",
"kind": 64,
"children": [185, 192, 190, 188]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 320,
"name": "\"lib/polyfills\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/polyfills.ts",
"children": [
{
"id": 321,
"name": "polyfillGlobalThis",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 322,
"name": "polyfillGlobalThis",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "https://mathiasbynens.be/notes/globalthis"
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/polyfills.ts",
"line": 6,
"character": 34
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [321]
}
],
"sources": [
{
"fileName": "lib/polyfills.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 49,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/types.ts",
"children": [
{
"id": 92,
"name": "CookieOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 95,
"name": "domain",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 85,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 94,
"name": "lifetime",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 83,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 93,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 81,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 96,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 86,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 97,
"name": "sameSite",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 88,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [95, 94, 93, 96, 97]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 79,
"character": 30
}
]
},
{
"id": 50,
"name": "Session",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 52,
"name": "access_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 54,
"name": "expires_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "A timestamp of when the token will expire. Returned when a login is confirmed."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 20,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 53,
"name": "expires_in",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 16,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 51,
"name": "provider_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 11,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 55,
"name": "refresh_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 56,
"name": "token_type",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 57,
"name": "user",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 23,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "User"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [52, 54, 53, 51, 55, 56, 57]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 24
}
]
},
{
"id": 82,
"name": "Subscription",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 84,
"name": "callback",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The function to call every time there is an event. eg: (eventName) => {}"
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 72,
"character": 10
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 85,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 86,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 87,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 103,
"name": "AuthChangeEvent"
}
},
{
"id": 88,
"name": "session",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 50,
"name": "Session"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 72,
"character": 11
}
]
}
}
},
{
"id": 83,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The subscriber UUID. This will be set by the client."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 68,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 89,
"name": "unsubscribe",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Call this to remove the listener."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 76,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 90,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 91,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 76,
"character": 14
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [84, 83, 89]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 64,
"character": 29
}
]
},
{
"id": 58,
"name": "User",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 60,
"name": "app_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 14
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 61,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 63,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 64,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"children": [
{
"id": 62,
"name": "provider",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 28,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [62]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 15
}
]
}
}
},
{
"id": 69,
"name": "aud",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 34,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 70,
"name": "confirmation_sent_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 35,
"character": 22
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 73,
"name": "confirmed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 72,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 37,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 71,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 36,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 59,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 74,
"name": "last_sign_in_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 39,
"character": 17
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 75,
"name": "role",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 76,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 65,
"name": "user_metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 31,
"character": 15
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 66,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 67,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 68,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 31,
"character": 16
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [60, 69, 70, 73, 72, 71, 59, 74, 75, 76, 65]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 25,
"character": 21
}
]
},
{
"id": 77,
"name": "UserAttributes",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 81,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "A custom data object. Can be any JSON."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
},
{
"id": 78,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The user's email."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 48,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 80,
"name": "email_change_token",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "An email change token."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 56,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 79,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The user's password."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [81, 78, 80, 79]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 44,
"character": 31
}
]
},
{
"id": 98,
"name": "UserCredentials",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 99,
"name": "email",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 92,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 100,
"name": "password",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 93,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 101,
"name": "provider",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 95,
"character": 10
}
],
"type": {
"type": "reference",
"id": 102,
"name": "Provider"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [99, 100, 101]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 91,
"character": 32
}
]
},
{
"id": 103,
"name": "AuthChangeEvent",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 3,
"character": 27
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "SIGNED_IN"
},
{
"type": "stringLiteral",
"value": "SIGNED_OUT"
},
{
"type": "stringLiteral",
"value": "USER_UPDATED"
},
{
"type": "stringLiteral",
"value": "USER_DELETED"
},
{
"type": "stringLiteral",
"value": "PASSWORD_RECOVERY"
}
]
}
},
{
"id": 102,
"name": "Provider",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "azure"
},
{
"type": "stringLiteral",
"value": "bitbucket"
},
{
"type": "stringLiteral",
"value": "facebook"
},
{
"type": "stringLiteral",
"value": "github"
},
{
"type": "stringLiteral",
"value": "gitlab"
},
{
"type": "stringLiteral",
"value": "google"
}
]
}
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [92, 50, 82, 58, 77, 98]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [103, 102]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [196, 323, 498, 104, 117, 1, 161, 320, 49]
}
]
},
{
"id": 0,
"name": "@supabase/postgrest-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 420,
"name": "\"PostgrestClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/PostgrestClient.ts",
"children": [
{
"id": 421,
"name": "PostgrestClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 428,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a PostgREST client."
},
"signatures": [
{
"id": 429,
"name": "new PostgrestClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a PostgREST client."
},
"parameters": [
{
"id": 430,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "URL of the PostgREST endpoint."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 431,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 432,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 433,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Custom headers."
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 19,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 434,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 435,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 436,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 437,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Postgres schema to switch to.\n"
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 19,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [433, 437]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 18,
"character": 16
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 421,
"name": "PostgrestClient"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 8,
"character": 17
}
]
},
{
"id": 423,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 7,
"character": 9
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 424,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 425,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 426,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 7,
"character": 10
}
]
}
}
},
{
"id": 427,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 8,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 422,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 6,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 438,
"name": "auth",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 439,
"name": "auth",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Authenticates the request with JWT."
},
"parameters": [
{
"id": 440,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The JWT token to use.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 31,
"character": 6
}
]
},
{
"id": 441,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 442,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a table operation."
},
"typeParameter": [
{
"id": 443,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 444,
"name": "table",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The table name to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 306,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "PostgrestQueryBuilder"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 41,
"character": 6
}
]
},
{
"id": 445,
"name": "rpc",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 446,
"name": "rpc",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a stored procedure call."
},
"typeParameter": [
{
"id": 447,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 448,
"name": "fn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The function name to call."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 449,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The parameters to pass to the function call."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
},
{
"id": 450,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 451,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 452,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 57,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [452]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 55,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T",
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 53,
"character": 5
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [428]
},
{
"title": "Properties",
"kind": 1024,
"children": [423, 427, 422]
},
{
"title": "Methods",
"kind": 2048,
"children": [438, 441, 445]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 5,
"character": 36
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [421]
}
],
"sources": [
{
"fileName": "PostgrestClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 453,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/index.ts",
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 114,
"name": "\"lib/PostgrestFilterBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestFilterBuilder.ts",
"children": [
{
"id": 115,
"name": "PostgrestFilterBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 116,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 289,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 290,
"name": "new PostgrestFilterBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 291,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 115,
"name": "PostgrestFilterBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 44
}
],
"inheritedFrom": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 202,
"name": "adj",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `rangeAdjacent()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 306,
"character": 5
}
],
"type": {
"type": "reference",
"id": 198,
"name": "rangeAdjacent"
},
"defaultValue": "this.rangeAdjacent"
},
{
"id": 288,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 36,
"name": "PostgrestBuilder.body"
}
},
{
"id": 177,
"name": "cd",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `containedBy()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 231,
"character": 4
}
],
"type": {
"type": "reference",
"id": 173,
"name": "containedBy"
},
"defaultValue": "this.containedBy"
},
{
"id": 172,
"name": "cs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `contains()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 207,
"character": 4
}
],
"type": {
"type": "reference",
"id": 168,
"name": "contains"
},
"defaultValue": "this.contains"
},
{
"id": 283,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 284,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 285,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 286,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 281,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.method"
}
},
{
"id": 192,
"name": "nxl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `rangeGte()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 276,
"character": 5
}
],
"type": {
"type": "reference",
"id": 188,
"name": "rangeGte"
},
"defaultValue": "this.rangeGte"
},
{
"id": 197,
"name": "nxr",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `rangeLte()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 291,
"character": 5
}
],
"type": {
"type": "reference",
"id": 193,
"name": "rangeLte"
},
"defaultValue": "this.rangeLte"
},
{
"id": 207,
"name": "ov",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `overlaps()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 327,
"character": 4
}
],
"type": {
"type": "reference",
"id": 203,
"name": "overlaps"
},
"defaultValue": "this.overlaps"
},
{
"id": 287,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 182,
"name": "sl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `rangeLt()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 246,
"character": 4
}
],
"type": {
"type": "reference",
"id": 178,
"name": "rangeLt"
},
"defaultValue": "this.rangeLt"
},
{
"id": 187,
"name": "sr",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `rangeGt()` instead."
}
]
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 261,
"character": 4
}
],
"type": {
"type": "reference",
"id": 183,
"name": "rangeGt"
},
"defaultValue": "this.rangeGt"
},
{
"id": 282,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.url"
}
},
{
"id": 173,
"name": "containedBy",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 174,
"name": "containedBy",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`."
},
"parameters": [
{
"id": 175,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 176,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 216,
"character": 13
}
]
},
{
"id": 168,
"name": "contains",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 169,
"name": "contains",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`."
},
"parameters": [
{
"id": 170,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 171,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 191,
"character": 10
}
]
},
{
"id": 128,
"name": "eq",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 129,
"name": "eq",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`."
},
"parameters": [
{
"id": 130,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 131,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 63,
"character": 4
}
]
},
{
"id": 244,
"name": "filter",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 245,
"name": "filter",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose `column` satisfies the filter."
},
"parameters": [
{
"id": 246,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 247,
"name": "operator",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The operator to filter with."
},
"type": {
"type": "reference",
"id": 304,
"name": "FilterOperator"
}
},
{
"id": 248,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 430,
"character": 8
}
]
},
{
"id": 216,
"name": "fts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 217,
"name": "fts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nto_tsquery(`query`).",
"tags": [
{
"tag": "deprecated",
"text": "Use `textSearch()` instead.\n"
}
]
},
"parameters": [
{
"id": 218,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 219,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 220,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 221,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 222,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 369,
"character": 46
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [222]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 369,
"character": 37
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 369,
"character": 5
}
]
},
{
"id": 136,
"name": "gt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 137,
"name": "gt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`."
},
"parameters": [
{
"id": 138,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 139,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 87,
"character": 4
}
]
},
{
"id": 140,
"name": "gte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 141,
"name": "gte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`."
},
"parameters": [
{
"id": 142,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 143,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 99,
"character": 5
}
]
},
{
"id": 156,
"name": "ilike",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 157,
"name": "ilike",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)."
},
"parameters": [
{
"id": 158,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 159,
"name": "pattern",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The pattern to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 147,
"character": 7
}
]
},
{
"id": 164,
"name": "in",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 165,
"name": "in",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`."
},
"parameters": [
{
"id": 166,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 167,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to filter with.\n"
},
"type": {
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 171,
"character": 4
}
]
},
{
"id": 160,
"name": "is",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 161,
"name": "is",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`."
},
"parameters": [
{
"id": 162,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 163,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "boolean"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 159,
"character": 4
}
]
},
{
"id": 152,
"name": "like",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 153,
"name": "like",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)."
},
"parameters": [
{
"id": 154,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 155,
"name": "pattern",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The pattern to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 135,
"character": 6
}
]
},
{
"id": 266,
"name": "limit",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 267,
"name": "limit",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result with the specified `count`."
},
"parameters": [
{
"id": 268,
"name": "count",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The maximum no. of rows to limit to."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 269,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 270,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 271,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [271]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 22
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
},
"inheritedFrom": {
"type": "reference",
"id": 76,
"name": "PostgrestTransformBuilder.limit"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 76,
"name": "PostgrestTransformBuilder.limit"
}
},
{
"id": 144,
"name": "lt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 145,
"name": "lt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`."
},
"parameters": [
{
"id": 146,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 147,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 111,
"character": 4
}
]
},
{
"id": 148,
"name": "lte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 149,
"name": "lte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`."
},
"parameters": [
{
"id": 150,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 151,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 123,
"character": 5
}
]
},
{
"id": 249,
"name": "match",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 250,
"name": "match",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose columns match the specified `query` object."
},
"parameters": [
{
"id": 251,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The object to filter with, with column names as keys mapped\n to their filter values.\n"
},
"type": {
"type": "reflection",
"declaration": {
"id": 252,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 253,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 254,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 441,
"character": 14
}
]
}
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 441,
"character": 7
}
]
},
{
"id": 132,
"name": "neq",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 133,
"name": "neq",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`."
},
"parameters": [
{
"id": 134,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 135,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 75,
"character": 5
}
]
},
{
"id": 117,
"name": "not",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 118,
"name": "not",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows which doesn't satisfy the filter."
},
"parameters": [
{
"id": 119,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 120,
"name": "operator",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The operator to filter with."
},
"type": {
"type": "reference",
"id": 304,
"name": "FilterOperator"
}
},
{
"id": 121,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 39,
"character": 5
}
]
},
{
"id": 122,
"name": "or",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "or",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows satisfying at least one of the filters."
},
"parameters": [
{
"id": 124,
"name": "filters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The filters to use, separated by commas."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 125,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 126,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 127,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (if `column` is a foreign column).\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 50,
"character": 36
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [127]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 50,
"character": 21
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 50,
"character": 4
}
]
},
{
"id": 258,
"name": "order",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 259,
"name": "order",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Orders the result with the specified `column`."
},
"parameters": [
{
"id": 260,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to order on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 261,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 263,
"name": "ascending",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, the result will be in ascending order."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 43,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 265,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (if `column` is a foreign column).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 45,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 264,
"name": "nullsFirst",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, `null`s appear first."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 44,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [263, 265, 264]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 41,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
},
"inheritedFrom": {
"type": "reference",
"id": 68,
"name": "PostgrestTransformBuilder.order"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 40,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 68,
"name": "PostgrestTransformBuilder.order"
}
},
{
"id": 203,
"name": "overlaps",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 204,
"name": "overlaps",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose array or range value on the stated `column` overlaps\n(has a value in common) with the specified `value`."
},
"parameters": [
{
"id": 205,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 206,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The value to filter with.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "array",
"elementType": {
"type": "indexedAccess",
"indexType": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
},
"objectType": {
"type": "typeParameter",
"name": "T"
}
}
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 315,
"character": 10
}
]
},
{
"id": 230,
"name": "phfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 231,
"name": "phfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nphraseto_tsquery(`query`).",
"tags": [
{
"tag": "deprecated",
"text": "Use `textSearch()` with `type: 'phrase'` instead.\n"
}
]
},
"parameters": [
{
"id": 232,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 233,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 234,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 235,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 236,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 401,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [236]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 401,
"character": 39
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 401,
"character": 7
}
]
},
{
"id": 223,
"name": "plfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 224,
"name": "plfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nplainto_tsquery(`query`).",
"tags": [
{
"tag": "deprecated",
"text": "Use `textSearch()` with `type: 'plain'` instead.\n"
}
]
},
"parameters": [
{
"id": 225,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 226,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 227,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 228,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 229,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 385,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [229]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 385,
"character": 39
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 385,
"character": 7
}
]
},
{
"id": 272,
"name": "range",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 273,
"name": "range",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result to rows within the specified range, inclusive."
},
"parameters": [
{
"id": 274,
"name": "from",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The starting index from which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 275,
"name": "to",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The last index to which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 276,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 278,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [278]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 33
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
},
"inheritedFrom": {
"type": "reference",
"id": 82,
"name": "PostgrestTransformBuilder.range"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 7
}
],
"inheritedFrom": {
"type": "reference",
"id": 82,
"name": "PostgrestTransformBuilder.range"
}
},
{
"id": 198,
"name": "rangeAdjacent",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 199,
"name": "rangeAdjacent",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`."
},
"parameters": [
{
"id": 200,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 201,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 300,
"character": 15
}
]
},
{
"id": 183,
"name": "rangeGt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 184,
"name": "rangeGt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`."
},
"parameters": [
{
"id": 185,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 186,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 255,
"character": 9
}
]
},
{
"id": 188,
"name": "rangeGte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 189,
"name": "rangeGte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`."
},
"parameters": [
{
"id": 190,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 191,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 270,
"character": 10
}
]
},
{
"id": 178,
"name": "rangeLt",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 179,
"name": "rangeLt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`."
},
"parameters": [
{
"id": 180,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 181,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 240,
"character": 9
}
]
},
{
"id": 193,
"name": "rangeLte",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 194,
"name": "rangeLte",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`."
},
"parameters": [
{
"id": 195,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 196,
"name": "range",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The range to filter with.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 285,
"character": 10
}
]
},
{
"id": 255,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 256,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs vertical filtering with SELECT."
},
"parameters": [
{
"id": 257,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The columns to retrieve, separated by commas.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"*\""
}
],
"type": {
"type": "intrinsic",
"name": "this"
},
"inheritedFrom": {
"type": "reference",
"id": 65,
"name": "PostgrestTransformBuilder.select"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 13,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 65,
"name": "PostgrestTransformBuilder.select"
}
},
{
"id": 279,
"name": "single",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 280,
"name": "single",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 60,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestSingleResponse"
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 89,
"name": "PostgrestTransformBuilder.single"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 92,
"character": 8
}
],
"inheritedFrom": {
"type": "reference",
"id": 89,
"name": "PostgrestTransformBuilder.single"
}
},
{
"id": 208,
"name": "textSearch",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 209,
"name": "textSearch",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose text or tsvector value on the stated `column` matches\nthe tsquery in `query`."
},
"parameters": [
{
"id": 210,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 211,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 212,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 213,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 214,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use."
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 342,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 215,
"name": "type",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The type of tsquery conversion to use on `query`.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 343,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "plain"
},
{
"type": "stringLiteral",
"value": "phrase"
},
{
"type": "stringLiteral",
"value": "websearch"
}
]
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [214, 215]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 340,
"character": 18
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 338,
"character": 12
}
]
},
{
"id": 292,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 293,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 294,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 295,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 296,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 297,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 298,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 299,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 63,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 300,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 301,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 302,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 303,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 66,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
},
{
"id": 237,
"name": "wfts",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 238,
"name": "wfts",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Finds all rows whose tsvector value on the stated `column` matches\nwebsearch_to_tsquery(`query`).",
"tags": [
{
"tag": "deprecated",
"text": "Use `textSearch()` with `type: 'websearch'` instead.\n"
}
]
},
"parameters": [
{
"id": 239,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to filter on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 240,
"name": "query",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The Postgres tsquery string to filter with."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 241,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 242,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 243,
"name": "config",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The text search configuration to use.\n"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 417,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [243]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 417,
"character": 38
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 417,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [289]
},
{
"title": "Properties",
"kind": 1024,
"children": [202, 288, 177, 172, 283, 281, 192, 197, 207, 287, 182, 187, 282]
},
{
"title": "Methods",
"kind": 2048,
"children": [
173, 168, 128, 244, 216, 136, 140, 156, 164, 160, 152, 266, 144, 148, 249, 132,
117, 122, 258, 203, 230, 223, 272, 198, 183, 188, 178, 193, 255, 279, 208, 292,
237
]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 31,
"character": 43
}
],
"extendedTypes": [
{
"type": "reference",
"id": 63,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestTransformBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
},
{
"id": 304,
"name": "FilterOperator",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"comment": {
"shortText": "Filters"
},
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 7,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "eq"
},
{
"type": "stringLiteral",
"value": "neq"
},
{
"type": "stringLiteral",
"value": "gt"
},
{
"type": "stringLiteral",
"value": "gte"
},
{
"type": "stringLiteral",
"value": "lt"
},
{
"type": "stringLiteral",
"value": "lte"
},
{
"type": "stringLiteral",
"value": "like"
},
{
"type": "stringLiteral",
"value": "ilike"
},
{
"type": "stringLiteral",
"value": "is"
},
{
"type": "stringLiteral",
"value": "in"
},
{
"type": "stringLiteral",
"value": "cs"
},
{
"type": "stringLiteral",
"value": "cd"
},
{
"type": "stringLiteral",
"value": "sl"
},
{
"type": "stringLiteral",
"value": "sr"
},
{
"type": "stringLiteral",
"value": "nxl"
},
{
"type": "stringLiteral",
"value": "nxr"
},
{
"type": "stringLiteral",
"value": "adj"
},
{
"type": "stringLiteral",
"value": "ov"
},
{
"type": "stringLiteral",
"value": "fts"
},
{
"type": "stringLiteral",
"value": "plfts"
},
{
"type": "stringLiteral",
"value": "phfts"
},
{
"type": "stringLiteral",
"value": "wfts"
}
]
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [115]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [304]
}
],
"sources": [
{
"fileName": "lib/PostgrestFilterBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 305,
"name": "\"lib/PostgrestQueryBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestQueryBuilder.ts",
"children": [
{
"id": 306,
"name": "PostgrestQueryBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 307,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 308,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 309,
"name": "new PostgrestQueryBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 310,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 311,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 313,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 7,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 314,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 315,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 316,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 317,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 7,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [313, 317]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 6,
"character": 16
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 306,
"name": "PostgrestQueryBuilder"
},
"overwrites": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 4,
"character": 75
}
],
"overwrites": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 368,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 36,
"name": "PostgrestBuilder.body"
}
},
{
"id": 363,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 364,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 365,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 366,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 361,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.method"
}
},
{
"id": 367,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 362,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.url"
}
},
{
"id": 355,
"name": "delete",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 356,
"name": "delete",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs a DELETE on the table."
},
"parameters": [
{
"id": 357,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 358,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 360,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 191,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
},
{
"id": 359,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, return the deleted row(s) in the response."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 190,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
},
"defaultValue": "\"representation\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [360, 359]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 189,
"character": 9
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 189,
"character": 8
}
]
},
{
"id": 325,
"name": "insert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 326,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an INSERT into the table."
},
"parameters": [
{
"id": 327,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 328,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 329,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 331,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 68,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 330,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 67,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [331, 330]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
},
{
"id": 332,
"name": "insert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"tags": [
{
"tag": "deprecated",
"text": "Use `upsert()` instead.\n"
}
]
},
"parameters": [
{
"id": 333,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 334,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 335,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 339,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 80,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
}
},
{
"id": 337,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 78,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 338,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 79,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
}
},
{
"id": 336,
"name": "upsert",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 77,
"character": 12
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [339, 337, 338, 336]
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 64,
"character": 8
},
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 74,
"character": 8
},
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 83,
"character": 8
}
]
},
{
"id": 318,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 319,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs vertical filtering with SELECT."
},
"parameters": [
{
"id": 320,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The columns to retrieve, separated by commas."
},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"*\""
},
{
"id": 321,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 322,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 324,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 26,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
},
{
"id": 323,
"name": "head",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "When set to true, select will void data."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 25,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [324, 323]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 23,
"character": 18
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 22,
"character": 8
}
]
},
{
"id": 369,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 370,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 371,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 372,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 373,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 374,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 375,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 376,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 63,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 377,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 378,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 379,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 380,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 66,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
},
{
"id": 348,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 349,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPDATE on the table."
},
"parameters": [
{
"id": 350,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to update."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
},
{
"id": 351,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 352,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 354,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 167,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
},
{
"id": 353,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By default the updated record is returned. Set this to 'minimal' if you don't need this value."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 166,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
},
"defaultValue": "\"representation\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [354, 353]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 164,
"character": 23
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 163,
"character": 8
}
]
},
{
"id": 340,
"name": "upsert",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 341,
"name": "upsert",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs an UPSERT into the table."
},
"parameters": [
{
"id": 342,
"name": "values",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The values to insert."
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 343,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 344,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 347,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "Count algorithm to use to count rows in a table.\n"
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 134,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
},
{
"id": 345,
"name": "onConflict",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 132,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 346,
"name": "returning",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "By default the new record is returned. Set this to 'minimal' if you don't need this value."
},
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 133,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "minimal"
},
{
"type": "stringLiteral",
"value": "representation"
}
]
},
"defaultValue": "\"representation\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [347, 345, 346]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 130,
"character": 38
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 129,
"character": 8
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [308]
},
{
"title": "Properties",
"kind": 1024,
"children": [368, 363, 361, 367, 362]
},
{
"title": "Methods",
"kind": 2048,
"children": [355, 325, 318, 369, 348, 340]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 4,
"character": 42
}
],
"extendedTypes": [
{
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [306]
}
],
"sources": [
{
"fileName": "lib/PostgrestQueryBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 381,
"name": "\"lib/PostgrestRpcBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestRpcBuilder.ts",
"children": [
{
"id": 382,
"name": "PostgrestRpcBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 383,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 384,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 385,
"name": "new PostgrestRpcBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 386,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 387,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 388,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 389,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 7,
"character": 13
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 390,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 391,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 392,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
},
{
"id": 393,
"name": "schema",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 7,
"character": 26
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [389, 393]
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 6,
"character": 16
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 382,
"name": "PostgrestRpcBuilder"
},
"overwrites": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 4,
"character": 73
}
],
"overwrites": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 407,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 36,
"name": "PostgrestBuilder.body"
}
},
{
"id": 402,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 403,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 404,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 405,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 400,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.method"
}
},
{
"id": 406,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 401,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.url"
}
},
{
"id": 394,
"name": "rpc",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 395,
"name": "rpc",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform a stored procedure call."
},
"parameters": [
{
"id": 396,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
},
{
"id": 397,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 398,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 399,
"name": "count",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 21,
"character": 11
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "stringLiteral",
"value": "exact"
},
{
"type": "stringLiteral",
"value": "planned"
},
{
"type": "stringLiteral",
"value": "estimated"
}
]
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [399]
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 19,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 115,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestFilterBuilder"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 18,
"character": 5
}
]
},
{
"id": 408,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 409,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 410,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 411,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 412,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 413,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 414,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 415,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 63,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 416,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 417,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 418,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 419,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 66,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [384]
},
{
"title": "Properties",
"kind": 1024,
"children": [407, 402, 400, 406, 401]
},
{
"title": "Methods",
"kind": 2048,
"children": [394, 408]
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 4,
"character": 40
}
],
"extendedTypes": [
{
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [382]
}
],
"sources": [
{
"fileName": "lib/PostgrestRpcBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 62,
"name": "\"lib/PostgrestTransformBuilder\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestTransformBuilder.ts",
"children": [
{
"id": 63,
"name": "PostgrestTransformBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Post-filters (transforms)"
},
"typeParameter": [
{
"id": 64,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 99,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 100,
"name": "new PostgrestTransformBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 101,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 63,
"name": "PostgrestTransformBuilder"
},
"inheritedFrom": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 44
}
],
"inheritedFrom": {
"type": "reference",
"id": 37,
"name": "PostgrestBuilder.__constructor"
}
},
{
"id": 98,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 36,
"name": "PostgrestBuilder.body"
}
},
{
"id": 93,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 94,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 95,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 96,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 21
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 31,
"name": "PostgrestBuilder.headers"
}
},
{
"id": 91,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 29,
"name": "PostgrestBuilder.method"
}
},
{
"id": 97,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "PostgrestBuilder.schema"
}
},
{
"id": 92,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
},
"inheritedFrom": {
"type": "reference",
"id": 30,
"name": "PostgrestBuilder.url"
}
},
{
"id": 76,
"name": "limit",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 77,
"name": "limit",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result with the specified `count`."
},
"parameters": [
{
"id": 78,
"name": "count",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The maximum no. of rows to limit to."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 79,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 80,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 81,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [81]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 22
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 66,
"character": 7
}
]
},
{
"id": 68,
"name": "order",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 69,
"name": "order",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Orders the result with the specified `column`."
},
"parameters": [
{
"id": 70,
"name": "column",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The column to order on."
},
"type": {
"type": "typeOperator",
"operator": "keyof",
"target": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 71,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__1",
"type": {
"type": "reflection",
"declaration": {
"id": 72,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 73,
"name": "ascending",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, the result will be in ascending order."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 43,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 75,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (if `column` is a foreign column).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 45,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 74,
"name": "nullsFirst",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "If `true`, `null`s appear first."
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 44,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [73, 75, 74]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 41,
"character": 20
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 40,
"character": 7
}
]
},
{
"id": 82,
"name": "range",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 83,
"name": "range",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Limits the result to rows within the specified range, inclusive."
},
"parameters": [
{
"id": 84,
"name": "from",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The starting index from which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 85,
"name": "to",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The last index to which to limit the result, inclusive."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 86,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__2",
"type": {
"type": "reflection",
"declaration": {
"id": 87,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 88,
"name": "foreignTable",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"comment": {
"text": "The foreign table to use (for foreign columns).\n"
},
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [88]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 33
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 79,
"character": 7
}
]
},
{
"id": 65,
"name": "select",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 66,
"name": "select",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Performs vertical filtering with SELECT."
},
"parameters": [
{
"id": 67,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The columns to retrieve, separated by commas.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"*\""
}
],
"type": {
"type": "intrinsic",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 13,
"character": 8
}
]
},
{
"id": 89,
"name": "single",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 90,
"name": "single",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 60,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestSingleResponse"
}
],
"name": "PromiseLike"
}
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 92,
"character": 8
}
]
},
{
"id": 102,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 103,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 104,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 105,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 106,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 107,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 108,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 109,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 63,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 110,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 111,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 112,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 113,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 66,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
},
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
],
"inheritedFrom": {
"type": "reference",
"id": 40,
"name": "PostgrestBuilder.then"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [99]
},
{
"title": "Properties",
"kind": 1024,
"children": [98, 93, 91, 97, 92]
},
{
"title": "Methods",
"kind": 2048,
"children": [76, 68, 82, 65, 89, 102]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 7,
"character": 46
}
],
"extendedTypes": [
{
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
],
"extendedBy": [
{
"type": "reference",
"id": 115,
"name": "PostgrestFilterBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [63]
}
],
"sources": [
{
"fileName": "lib/PostgrestTransformBuilder.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/types.ts",
"children": [
{
"id": 27,
"name": "PostgrestBuilder",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true,
"isAbstract": true
},
"typeParameter": [
{
"id": 28,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"children": [
{
"id": 37,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 38,
"name": "new PostgrestBuilder",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 39,
"name": "builder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 27,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestBuilder"
}
}
],
"type": {
"type": "reference",
"id": 27,
"name": "PostgrestBuilder"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 44
}
]
},
{
"id": 36,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 55,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
},
{
"type": "array",
"elementType": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "Partial"
}
}
]
}
},
{
"id": 31,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 32,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 33,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 34,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 53,
"character": 21
}
]
}
}
},
{
"id": 29,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "HEAD"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PATCH"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 35,
"name": "schema",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 54,
"character": 18
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 30,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 52,
"character": 15
}
],
"type": {
"type": "reference",
"name": "URL"
}
},
{
"id": 40,
"name": "then",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 41,
"name": "then",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 42,
"name": "TResult1",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
},
{
"id": 43,
"name": "TResult2",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"parameters": [
{
"id": 44,
"name": "onfulfilled",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 45,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 46,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 47,
"name": "value",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 63,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 48,
"name": "onrejected",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 49,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 50,
"name": "__call",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 51,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
},
{
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
],
"name": "PromiseLike"
}
]
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 66,
"character": 18
}
]
}
},
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "typeParameter",
"name": "TResult1",
"default": {
"type": "reference",
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
},
{
"type": "typeParameter",
"name": "TResult2",
"default": {
"type": "intrinsic",
"name": "never"
}
}
]
}
],
"name": "PromiseLike"
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 61,
"character": 6
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [37]
},
{
"title": "Properties",
"kind": 1024,
"children": [36, 31, 29, 35, 30]
},
{
"title": "Methods",
"kind": 2048,
"children": [40]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 50,
"character": 38
}
],
"extendedBy": [
{
"type": "reference",
"id": 63,
"name": "PostgrestTransformBuilder"
},
{
"type": "reference",
"id": 306,
"name": "PostgrestQueryBuilder"
},
{
"type": "reference",
"id": 382,
"name": "PostgrestRpcBuilder"
}
],
"implementedTypes": [
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponse"
}
],
"name": "PromiseLike"
}
]
},
{
"id": 2,
"name": "PostgrestResponseBase",
"kind": 256,
"kindString": "Interface",
"flags": {},
"comment": {
"shortText": "Response format",
"text": "{@link https://github.com/supabase/supabase-js/issues/32}\n"
},
"children": [
{
"id": 3,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 4,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [3, 4]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 20,
"character": 31
}
],
"extendedBy": [
{
"type": "reference",
"id": 5,
"name": "PostgrestResponseSuccess"
},
{
"type": "reference",
"id": 13,
"name": "PostgrestResponseFailure"
},
{
"type": "reference",
"id": 20,
"name": "PostgrestSingleResponseSuccess"
}
]
},
{
"id": 13,
"name": "PostgrestResponseFailure",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 16,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 35,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 17,
"name": "count",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 36,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 15,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 33,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 14,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 32,
"character": 7
}
],
"type": {
"type": "reference",
"id": 52,
"name": "PostgrestError"
}
},
{
"id": 18,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 3,
"name": "PostgrestResponseBase.status"
}
},
{
"id": 19,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 4,
"name": "PostgrestResponseBase.statusText"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [16, 17, 15, 14, 18, 19]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 31,
"character": 34
}
],
"extendedTypes": [
{
"type": "reference",
"id": 2,
"name": "PostgrestResponseBase"
}
]
},
{
"id": 5,
"name": "PostgrestResponseSuccess",
"kind": 256,
"kindString": "Interface",
"flags": {},
"typeParameter": [
{
"id": 6,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"children": [
{
"id": 9,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 28,
"character": 6
}
],
"type": {
"type": "array",
"elementType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 10,
"name": "count",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 29,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 8,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 6
}
],
"type": {
"type": "array",
"elementType": {
"type": "typeParameter",
"name": "T"
}
}
},
{
"id": 7,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 11,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 3,
"name": "PostgrestResponseBase.status"
}
},
{
"id": 12,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 4,
"name": "PostgrestResponseBase.statusText"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [9, 10, 8, 7, 11, 12]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 25,
"character": 34
}
],
"extendedTypes": [
{
"type": "reference",
"id": 2,
"name": "PostgrestResponseBase"
}
]
},
{
"id": 20,
"name": "PostgrestSingleResponseSuccess",
"kind": 256,
"kindString": "Interface",
"flags": {},
"typeParameter": [
{
"id": 21,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"children": [
{
"id": 24,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 44,
"character": 6
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 23,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 6
}
],
"type": {
"type": "typeParameter",
"name": "T"
}
},
{
"id": 22,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 41,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 25,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"inheritedFrom": {
"type": "reference",
"id": 3,
"name": "PostgrestResponseBase.status"
}
},
{
"id": 26,
"name": "statusText",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 4,
"name": "PostgrestResponseBase.statusText"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [24, 23, 22, 25, 26]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 40,
"character": 40
}
],
"extendedTypes": [
{
"type": "reference",
"id": 2,
"name": "PostgrestResponseBase"
}
]
},
{
"id": 52,
"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": "lib/types.ts",
"line": 8,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 53,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 57,
"name": "code",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 55,
"name": "details",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 56,
"name": "hint",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 11,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 54,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/types.ts",
"line": 9,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [57, 55, 56, 54]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 8,
"character": 21
}
]
}
}
},
{
"id": 58,
"name": "PostgrestResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 59,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 5,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestResponseSuccess"
},
{
"type": "reference",
"id": 13,
"name": "PostgrestResponseFailure"
}
]
}
},
{
"id": 60,
"name": "PostgrestSingleResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"typeParameter": [
{
"id": 61,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {
"isExported": true
}
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 46,
"character": 35
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 20,
"typeArguments": [
{
"type": "typeParameter",
"name": "T"
}
],
"name": "PostgrestSingleResponseSuccess"
},
{
"type": "reference",
"id": 13,
"name": "PostgrestResponseFailure"
}
]
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [27]
},
{
"title": "Interfaces",
"kind": 256,
"children": [2, 13, 5, 20]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [52, 58, 60]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [420, 453, 114, 305, 381, 62, 1]
}
]
},
{
"id": 0,
"name": "@supabase/realtime-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 194,
"name": "\"RealtimeClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/RealtimeClient.ts",
"children": [
{
"id": 195,
"name": "RealtimeClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 226,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Socket"
},
"signatures": [
{
"id": 227,
"name": "new RealtimeClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Socket"
},
"parameters": [
{
"id": 228,
"name": "endPoint",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 229,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 301,
"name": "Options"
}
}
],
"type": {
"type": "reference",
"id": 195,
"name": "RealtimeClient"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 65,
"character": 3
}
]
},
{
"id": 196,
"name": "channels",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 36,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
"defaultValue": "[]"
},
{
"id": 218,
"name": "conn",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 52,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "WebSocket"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 216,
"name": "decode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 50,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 215,
"name": "encode",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 49,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 197,
"name": "endPoint",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 37,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
},
{
"id": 198,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 38,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 199,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 200,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 201,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 208,
"name": "heartbeatIntervalMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 42,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "30000"
},
{
"id": 210,
"name": "heartbeatTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 44,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"typeArguments": [
{
"type": "query",
"queryType": {
"type": "reference",
"name": "setInterval"
}
}
],
"name": "ReturnType"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 214,
"name": "logger",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 48,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
},
"defaultValue": "noop"
},
{
"id": 209,
"name": "longpollerTimeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 43,
"character": 19
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "20000"
},
{
"id": 202,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 39,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 203,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 204,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 205,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 211,
"name": "pendingHeartbeatRef",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 45,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 217,
"name": "reconnectAfterMs",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 51,
"character": 18
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 213,
"name": "reconnectTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 47,
"character": 16
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
},
{
"id": 212,
"name": "ref",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 46,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 219,
"name": "sendBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 53,
"character": 12
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "Function"
}
},
"defaultValue": "[]"
},
{
"id": 220,
"name": "serializer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 54,
"character": 12
}
],
"type": {
"type": "reference",
"id": 170,
"name": "Serializer"
},
"defaultValue": "new Serializer()"
},
{
"id": 206,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 40,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "DEFAULT_TIMEOUT"
},
{
"id": 207,
"name": "transport",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 41,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "WebSocket"
},
{
"id": 288,
"name": "_appendParams",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 289,
"name": "_appendParams",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 290,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 291,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 292,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 293,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 294,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 344,
"character": 44
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 344,
"character": 23
}
]
},
{
"id": 295,
"name": "_flushSendBuffer",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 296,
"name": "_flushSendBuffer",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 354,
"character": 26
}
]
},
{
"id": 280,
"name": "_onConnClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 281,
"name": "_onConnClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 282,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 324,
"character": 22
}
]
},
{
"id": 283,
"name": "_onConnError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 284,
"name": "_onConnError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 285,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Error"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 332,
"character": 22
}
]
},
{
"id": 278,
"name": "_onConnOpen",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 279,
"name": "_onConnOpen",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 316,
"character": 21
}
]
},
{
"id": 297,
"name": "_resetHeartbeat",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 298,
"name": "_resetHeartbeat",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 361,
"character": 25
}
]
},
{
"id": 299,
"name": "_sendHeartbeat",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 300,
"name": "_sendHeartbeat",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 370,
"character": 24
}
]
},
{
"id": 286,
"name": "_triggerChanError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 287,
"name": "_triggerChanError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 338,
"character": 27
}
]
},
{
"id": 263,
"name": "channel",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 264,
"name": "channel",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 265,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 266,
"name": "chanParams",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 267,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 246,
"character": 9
}
]
},
{
"id": 230,
"name": "connect",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 231,
"name": "connect",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Connects the socket."
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 117,
"character": 9
}
]
},
{
"id": 256,
"name": "connectionState",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 257,
"name": "connectionState",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the current state of the socket."
},
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "connecting"
},
{
"type": "stringLiteral",
"value": "open"
},
{
"type": "stringLiteral",
"value": "closing"
},
{
"type": "stringLiteral",
"value": "closed"
}
]
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 215,
"character": 17
}
]
},
{
"id": 232,
"name": "disconnect",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 233,
"name": "disconnect",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Disconnects the socket."
},
"parameters": [
{
"id": 234,
"name": "code",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "A numeric status code to send on disconnect."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 235,
"name": "reason",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "A custom reason for the disconnect.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 238,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 40
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 237,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [238, 237]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 142,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 139,
"character": 12
}
]
},
{
"id": 274,
"name": "endPointURL",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 275,
"name": "endPointURL",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Returns the URL of the websocket."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 295,
"character": 13
}
]
},
{
"id": 258,
"name": "isConnected",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 259,
"name": "isConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retuns `true` is the connection is open."
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 231,
"character": 13
}
]
},
{
"id": 239,
"name": "log",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 240,
"name": "log",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Logs the message. Override `this.logger` for specialized logging."
},
"parameters": [
{
"id": 241,
"name": "kind",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 242,
"name": "msg",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 243,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 164,
"character": 5
}
]
},
{
"id": 276,
"name": "makeRef",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 277,
"name": "makeRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Return the next message ref, accounting for overflows"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 305,
"character": 9
}
]
},
{
"id": 247,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 248,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Registers a callbacks for connection state change events.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket closed.\"))\n"
}
]
},
"parameters": [
{
"id": 249,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 186,
"character": 9
}
]
},
{
"id": 271,
"name": "onConnMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 272,
"name": "onConnMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 273,
"name": "rawMessage",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 267,
"character": 15
}
]
},
{
"id": 250,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 251,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Registers a callback for connection state change events.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen((error) => console.log(\"An error occurred\"))\n"
}
]
},
"parameters": [
{
"id": 252,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 197,
"character": 9
}
]
},
{
"id": 253,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 254,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Calls a function any time a message is received.",
"tags": [
{
"tag": "example",
"text": "\n socket.onMessage((message) => console.log(message))\n"
}
]
},
"parameters": [
{
"id": 255,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 208,
"character": 11
}
]
},
{
"id": 244,
"name": "onOpen",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 245,
"name": "onOpen",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Registers a callback for connection state change event.",
"tags": [
{
"tag": "example",
"text": "\n socket.onOpen(() => console.log(\"Socket opened.\"))\n"
}
]
},
"parameters": [
{
"id": 246,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A function to be called when the event occurs.\n"
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 175,
"character": 8
}
]
},
{
"id": 268,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 269,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 270,
"name": "data",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 319,
"name": "Message"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 252,
"character": 6
}
]
},
{
"id": 260,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 261,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes a subscription from the socket."
},
"parameters": [
{
"id": 262,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "An open subscription.\n"
},
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 240,
"character": 8
}
]
},
{
"id": 221,
"name": "stateChangeCallbacks",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 223,
"name": "close",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 62,
"character": 9
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 224,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 63,
"character": 9
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 225,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 64,
"character": 11
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
},
{
"id": 222,
"name": "open",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 61,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "never"
}
},
"defaultValue": "[]"
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [223, 224, 225, 222]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 55,
"character": 22
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [226]
},
{
"title": "Properties",
"kind": 1024,
"children": [
196, 218, 216, 215, 197, 198, 208, 210, 214, 209, 202, 211, 217, 213, 212, 219,
220, 206, 207
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
288, 295, 280, 283, 278, 297, 299, 286, 263, 230, 256, 232, 274, 258, 239, 276,
247, 271, 250, 253, 244, 268, 260
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [221]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 35,
"character": 35
}
]
},
{
"id": 319,
"name": "Message",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 26,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 320,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 322,
"name": "event",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 28,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 323,
"name": "payload",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 29,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 324,
"name": "ref",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 30,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 321,
"name": "topic",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 27,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [322, 323, 324, 321]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 26,
"character": 14
}
]
}
}
},
{
"id": 301,
"name": "Options",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 302,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 309,
"name": "decode",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 21,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 308,
"name": "encode",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 20,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 311,
"name": "headers",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 23,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 313,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 314,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 305,
"name": "heartbeatIntervalMs",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 17,
"character": 21
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 307,
"name": "logger",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 19,
"character": 8
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 306,
"name": "longpollerTimeout",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 18,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 315,
"name": "params",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 24,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 316,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 317,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 318,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 310,
"name": "reconnectAfterMs",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 22,
"character": 18
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 304,
"name": "timeout",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 16,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 303,
"name": "transport",
"kind": 32,
"kindString": "Variable",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 15,
"character": 11
}
],
"type": {
"type": "reference",
"name": "WebSocket"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [309, 308, 311, 305, 307, 306, 315, 310, 304, 303]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 14,
"character": 14
}
]
}
}
},
{
"id": 325,
"name": "noop",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 326,
"name": "noop",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 33,
"character": 10
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [195]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [319, 301]
},
{
"title": "Functions",
"kind": 64,
"children": [325]
}
],
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 90,
"name": "\"RealtimeSubscription\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/RealtimeSubscription.ts",
"children": [
{
"id": 91,
"name": "RealtimeSubscription",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 99,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 103,
"name": "new RealtimeSubscription",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 104,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 105,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "{}"
},
{
"id": 106,
"name": "socket",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 195,
"name": "RealtimeClient"
}
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 13,
"character": 25
}
]
},
{
"id": 92,
"name": "bindings",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 7,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
},
"defaultValue": "[]"
},
{
"id": 96,
"name": "joinPush",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 11,
"character": 10
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
},
{
"id": 95,
"name": "joinedOnce",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 10,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 101,
"name": "params",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 17,
"character": 17
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 98,
"name": "pushBuffer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 13,
"character": 12
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 39,
"name": "Push"
}
},
"defaultValue": "[]"
},
{
"id": 97,
"name": "rejoinTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 12,
"character": 13
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
},
{
"id": 102,
"name": "socket",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 18,
"character": 17
}
],
"type": {
"type": "reference",
"id": 195,
"name": "RealtimeClient"
}
},
{
"id": 94,
"name": "state",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 9,
"character": 7
}
],
"type": {
"type": "reference",
"id": 7,
"name": "CHANNEL_STATES"
},
"defaultValue": "CHANNEL_STATES.closed"
},
{
"id": 93,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 8,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 100,
"name": "topic",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 16,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 125,
"name": "canPush",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 126,
"name": "canPush",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 97,
"character": 9
}
]
},
{
"id": 159,
"name": "isClosed",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 160,
"name": "isClosed",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 198,
"character": 10
}
]
},
{
"id": 161,
"name": "isErrored",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 162,
"name": "isErrored",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 201,
"character": 11
}
]
},
{
"id": 163,
"name": "isJoined",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 164,
"name": "isJoined",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 204,
"character": 10
}
]
},
{
"id": 165,
"name": "isJoining",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 166,
"name": "isJoining",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 207,
"character": 11
}
]
},
{
"id": 167,
"name": "isLeaving",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 168,
"name": "isLeaving",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 210,
"character": 11
}
]
},
{
"id": 140,
"name": "isMember",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 141,
"name": "isMember",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 142,
"name": "topic",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 151,
"character": 10
}
]
},
{
"id": 143,
"name": "joinRef",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 144,
"name": "joinRef",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 155,
"character": 9
}
]
},
{
"id": 122,
"name": "off",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 123,
"name": "off",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 124,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 93,
"character": 5
}
]
},
{
"id": 118,
"name": "on",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 119,
"name": "on",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 120,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 121,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 89,
"character": 4
}
]
},
{
"id": 112,
"name": "onClose",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 113,
"name": "onClose",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 114,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 81,
"character": 9
}
]
},
{
"id": 115,
"name": "onError",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 116,
"name": "onError",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 117,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 85,
"character": 9
}
]
},
{
"id": 135,
"name": "onMessage",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 136,
"name": "onMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Overridable message hook",
"text": "Receives all events for specialized message handling before dispatching to the channel callbacks.\nMust return the payload, modified or unmodified.\n"
},
"parameters": [
{
"id": 137,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 138,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 139,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 147,
"character": 11
}
]
},
{
"id": 127,
"name": "push",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 128,
"name": "push",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 129,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"id": 13,
"name": "CHANNEL_EVENTS"
}
},
{
"id": 130,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 131,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 101,
"character": 6
}
]
},
{
"id": 148,
"name": "rejoin",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 149,
"name": "rejoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 150,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 164,
"character": 8
}
]
},
{
"id": 107,
"name": "rejoinUntilConnected",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 108,
"name": "rejoinUntilConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 64,
"character": 22
}
]
},
{
"id": 156,
"name": "replyEventName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 157,
"name": "replyEventName",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 158,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 194,
"character": 16
}
]
},
{
"id": 145,
"name": "sendJoin",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 146,
"name": "sendJoin",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 147,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 159,
"character": 10
}
]
},
{
"id": 109,
"name": "subscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 110,
"name": "subscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 111,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 71,
"character": 11
}
]
},
{
"id": 151,
"name": "trigger",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 152,
"name": "trigger",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 153,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 154,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 155,
"name": "ref",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 171,
"character": 9
}
]
},
{
"id": 132,
"name": "unsubscribe",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 133,
"name": "unsubscribe",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 134,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "this.timeout"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 125,
"character": 13
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [99]
},
{
"title": "Properties",
"kind": 1024,
"children": [92, 96, 95, 101, 98, 97, 102, 94, 93, 100]
},
{
"title": "Methods",
"kind": 2048,
"children": [
125, 159, 161, 163, 165, 167, 140, 143, 122, 118, 112, 115, 135, 127, 148, 107,
156, 145, 109, 151, 132
]
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 6,
"character": 41
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [91]
}
],
"sources": [
{
"fileName": "RealtimeSubscription.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 413,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/index.ts",
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/constants\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/constants.ts",
"children": [
{
"id": 13,
"name": "CHANNEL_EVENTS",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 14,
"name": "close",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 23,
"character": 7
}
],
"defaultValue": "\"phx_close\""
},
{
"id": 15,
"name": "error",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 24,
"character": 7
}
],
"defaultValue": "\"phx_error\""
},
{
"id": 16,
"name": "join",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 25,
"character": 6
}
],
"defaultValue": "\"phx_join\""
},
{
"id": 18,
"name": "leave",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 27,
"character": 7
}
],
"defaultValue": "\"phx_leave\""
},
{
"id": 17,
"name": "reply",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 26,
"character": 7
}
],
"defaultValue": "\"phx_reply\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [14, 15, 16, 18, 17]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 22,
"character": 26
}
]
},
{
"id": 7,
"name": "CHANNEL_STATES",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 8,
"name": "closed",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 15,
"character": 8
}
],
"defaultValue": "\"closed\""
},
{
"id": 9,
"name": "errored",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 16,
"character": 9
}
],
"defaultValue": "\"errored\""
},
{
"id": 10,
"name": "joined",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 17,
"character": 8
}
],
"defaultValue": "\"joined\""
},
{
"id": 11,
"name": "joining",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 18,
"character": 9
}
],
"defaultValue": "\"joining\""
},
{
"id": 12,
"name": "leaving",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 19,
"character": 9
}
],
"defaultValue": "\"leaving\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [8, 9, 10, 11, 12]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 14,
"character": 26
}
]
},
{
"id": 2,
"name": "SOCKET_STATES",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 6,
"name": "closed",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 11,
"character": 8
}
],
"defaultValue": "3"
},
{
"id": 5,
"name": "closing",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 10,
"character": 9
}
],
"defaultValue": "2"
},
{
"id": 3,
"name": "connecting",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 8,
"character": 12
}
],
"defaultValue": "0"
},
{
"id": 4,
"name": "open",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 9,
"character": 6
}
],
"defaultValue": "1"
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [6, 5, 3, 4]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 7,
"character": 25
}
]
},
{
"id": 19,
"name": "TRANSPORTS",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"children": [
{
"id": 20,
"name": "websocket",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 31,
"character": 11
}
],
"defaultValue": "\"websocket\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [20]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 30,
"character": 22
}
]
},
{
"id": 22,
"name": "DEFAULT_TIMEOUT",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 3,
"character": 28
}
],
"type": {
"type": "unknown",
"name": "10000"
},
"defaultValue": "10000"
},
{
"id": 21,
"name": "VSN",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"1.0.0\""
},
{
"id": 23,
"name": "WS_CLOSE_NORMAL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isConst": true
},
"sources": [
{
"fileName": "lib/constants.ts",
"line": 5,
"character": 28
}
],
"type": {
"type": "unknown",
"name": "1000"
},
"defaultValue": "1000"
}
],
"groups": [
{
"title": "Enumerations",
"kind": 4,
"children": [13, 7, 2, 19]
},
{
"title": "Variables",
"kind": 32,
"children": [22, 21, 23]
}
],
"sources": [
{
"fileName": "lib/constants.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 38,
"name": "\"lib/push\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/push.ts",
"children": [
{
"id": 39,
"name": "Push",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 52,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Push"
},
"signatures": [
{
"id": 57,
"name": "new Push",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Initializes the Push"
},
"parameters": [
{
"id": 58,
"name": "channel",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The Channel"
},
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
{
"id": 59,
"name": "event",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The event, for example `\"phx_join\"`"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "payload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The payload, for example `{user_id: 123}`"
},
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "{}"
},
{
"id": 61,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The push timeout in milliseconds\n"
},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "DEFAULT_TIMEOUT"
}
],
"type": {
"type": "reference",
"id": 39,
"name": "Push"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 16,
"character": 32
}
]
},
{
"id": 53,
"name": "channel",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The Channel"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 27,
"character": 18
}
],
"type": {
"type": "reference",
"id": 91,
"name": "RealtimeSubscription"
}
},
{
"id": 54,
"name": "event",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The event, for example `\"phx_join\"`"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 28,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 55,
"name": "payload",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The payload, for example `{user_id: 123}`"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 29,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 47,
"name": "recHooks",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 12,
"character": 10
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 48,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 50,
"name": "callback",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 49,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 13,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [50, 49]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 12,
"character": 11
}
]
}
}
},
"defaultValue": "[]"
},
{
"id": 43,
"name": "receivedResp",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 8,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 44,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 46,
"name": "response",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 10,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 45,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 9,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [46, 45]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 8,
"character": 15
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 42,
"name": "ref",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 7,
"character": 5
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"\""
},
{
"id": 51,
"name": "refEvent",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 16,
"character": 10
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
},
"defaultValue": "null"
},
{
"id": 40,
"name": "sent",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 5,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
},
{
"id": 56,
"name": "timeout",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"comment": {
"shortText": "The push timeout in milliseconds\n"
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 30,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 41,
"name": "timeoutTimer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 6,
"character": 14
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 77,
"name": "_cancelRefEvent",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 78,
"name": "_cancelRefEvent",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 89,
"character": 25
}
]
},
{
"id": 79,
"name": "_cancelTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 80,
"name": "_cancelTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 96,
"character": 24
}
]
},
{
"id": 87,
"name": "_hasReceived",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 88,
"name": "_hasReceived",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 89,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 113,
"character": 22
}
]
},
{
"id": 81,
"name": "_matchReceive",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 82,
"name": "_matchReceive",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 83,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"originalName": "__0",
"type": {
"type": "reflection",
"declaration": {
"id": 84,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 86,
"name": "response",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 103,
"character": 12
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 85,
"name": "status",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/push.ts",
"line": 102,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [86, 85]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 101,
"character": 24
}
]
}
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 101,
"character": 23
}
]
},
{
"id": 67,
"name": "receive",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 68,
"name": "receive",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 69,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 70,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "unknown",
"name": "this"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 57,
"character": 9
}
]
},
{
"id": 62,
"name": "resend",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 63,
"name": "resend",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 64,
"name": "timeout",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 33,
"character": 8
}
]
},
{
"id": 65,
"name": "send",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 66,
"name": "send",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 43,
"character": 6
}
]
},
{
"id": 71,
"name": "startTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 72,
"name": "startTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 66,
"character": 14
}
]
},
{
"id": 73,
"name": "trigger",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 74,
"name": "trigger",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 75,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 76,
"name": "response",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 85,
"character": 9
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [52]
},
{
"title": "Properties",
"kind": 1024,
"children": [53, 54, 55, 47, 43, 42, 51, 40, 56, 41]
},
{
"title": "Methods",
"kind": 2048,
"children": [77, 79, 87, 81, 67, 62, 65, 71, 73]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 4,
"character": 25
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [39]
}
],
"sources": [
{
"fileName": "lib/push.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 169,
"name": "\"lib/serializer\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/serializer.ts",
"children": [
{
"id": 170,
"name": "Serializer",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 171,
"name": "HEADER_LENGTH",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "1"
},
{
"id": 176,
"name": "_binaryDecode",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 177,
"name": "_binaryDecode",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 178,
"name": "buffer",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "ArrayBuffer"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 179,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 182,
"name": "event",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 33,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 183,
"name": "payload",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 34,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 180,
"name": "ref",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 31,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 181,
"name": "topic",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 32,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [182, 183, 180, 181]
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 19,
"character": 23
}
]
},
{
"id": 184,
"name": "_decodeBroadcast",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPrivate": true,
"isExported": true
},
"signatures": [
{
"id": 185,
"name": "_decodeBroadcast",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 186,
"name": "buffer",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "ArrayBuffer"
}
},
{
"id": 187,
"name": "view",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "DataView"
}
},
{
"id": 188,
"name": "decoder",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "TextDecoder"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 189,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 192,
"name": "event",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 33,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 193,
"name": "payload",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 34,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 190,
"name": "ref",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 31,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "null"
}
},
{
"id": 191,
"name": "topic",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 32,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [192, 193, 190, 191]
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 30,
"character": 4
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 26,
"character": 26
}
]
},
{
"id": 172,
"name": "decode",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 173,
"name": "decode",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 174,
"name": "rawPayload",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "ArrayBuffer"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 175,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 7,
"character": 8
}
]
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [171]
},
{
"title": "Methods",
"kind": 2048,
"children": [176, 184, 172]
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 4,
"character": 31
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [170]
}
],
"sources": [
{
"fileName": "lib/serializer.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 24,
"name": "\"lib/timer\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/timer.ts",
"children": [
{
"id": 25,
"name": "Timer",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a timer that accepts a `timerCalc` function to perform calculated timeout retries, such as exponential backoff.",
"tags": [
{
"tag": "example",
"text": "\n let reconnectTimer = new Timer(() => this.connect(), function(tries){\n return [1000, 5000, 10000][tries - 1] || 10000\n })\n reconnectTimer.scheduleTimeout() // fires after 1000\n reconnectTimer.scheduleTimeout() // fires after 5000\n reconnectTimer.reset()\n reconnectTimer.scheduleTimeout() // fires after 1000\n"
}
]
},
"children": [
{
"id": 28,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 31,
"name": "new Timer",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 32,
"name": "callback",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 33,
"name": "timerCalc",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reference",
"name": "Function"
}
}
],
"type": {
"type": "reference",
"id": 25,
"name": "Timer"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 15,
"character": 19
}
]
},
{
"id": 29,
"name": "callback",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 17,
"character": 29
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 26,
"name": "timer",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 14,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "undefined"
}
]
},
"defaultValue": "undefined"
},
{
"id": 30,
"name": "timerCalc",
"kind": 1024,
"kindString": "Property",
"flags": {
"isPublic": true,
"isExported": true,
"isConstructorProperty": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 17,
"character": 57
}
],
"type": {
"type": "reference",
"name": "Function"
}
},
{
"id": 27,
"name": "tries",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/timer.ts",
"line": 15,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 34,
"name": "reset",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "reset",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 22,
"character": 7
}
]
},
{
"id": 36,
"name": "scheduleTimeout",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 37,
"name": "scheduleTimeout",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "void"
}
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 28,
"character": 17
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [28]
},
{
"title": "Properties",
"kind": 1024,
"children": [29, 26, 30, 27]
},
{
"title": "Methods",
"kind": 2048,
"children": [34, 36]
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 13,
"character": 26
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [25]
}
],
"sources": [
{
"fileName": "lib/timer.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 327,
"name": "\"lib/transformers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/realtime-js/realtime-js/src/lib/transformers.ts",
"children": [
{
"id": 328,
"name": "PostgresTypes",
"kind": 4,
"kindString": "Enumeration",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Helpers to convert the change Payload into native JS types."
},
"children": [
{
"id": 329,
"name": "abstime",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 9,
"character": 9
}
],
"defaultValue": "\"abstime\""
},
{
"id": 330,
"name": "bool",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 10,
"character": 6
}
],
"defaultValue": "\"bool\""
},
{
"id": 331,
"name": "date",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 11,
"character": 6
}
],
"defaultValue": "\"date\""
},
{
"id": 332,
"name": "daterange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 12,
"character": 11
}
],
"defaultValue": "\"daterange\""
},
{
"id": 333,
"name": "float4",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 13,
"character": 8
}
],
"defaultValue": "\"float4\""
},
{
"id": 334,
"name": "float8",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 14,
"character": 8
}
],
"defaultValue": "\"float8\""
},
{
"id": 335,
"name": "int2",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 15,
"character": 6
}
],
"defaultValue": "\"int2\""
},
{
"id": 336,
"name": "int4",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 16,
"character": 6
}
],
"defaultValue": "\"int4\""
},
{
"id": 337,
"name": "int4range",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 17,
"character": 11
}
],
"defaultValue": "\"int4range\""
},
{
"id": 338,
"name": "int8",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 18,
"character": 6
}
],
"defaultValue": "\"int8\""
},
{
"id": 339,
"name": "int8range",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 19,
"character": 11
}
],
"defaultValue": "\"int8range\""
},
{
"id": 340,
"name": "json",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 20,
"character": 6
}
],
"defaultValue": "\"json\""
},
{
"id": 341,
"name": "jsonb",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 21,
"character": 7
}
],
"defaultValue": "\"jsonb\""
},
{
"id": 342,
"name": "money",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 22,
"character": 7
}
],
"defaultValue": "\"money\""
},
{
"id": 343,
"name": "numeric",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 23,
"character": 9
}
],
"defaultValue": "\"numeric\""
},
{
"id": 344,
"name": "oid",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 24,
"character": 5
}
],
"defaultValue": "\"oid\""
},
{
"id": 345,
"name": "reltime",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 25,
"character": 9
}
],
"defaultValue": "\"reltime\""
},
{
"id": 346,
"name": "time",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 26,
"character": 6
}
],
"defaultValue": "\"time\""
},
{
"id": 347,
"name": "timestamp",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 27,
"character": 11
}
],
"defaultValue": "\"timestamp\""
},
{
"id": 348,
"name": "timestamptz",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 28,
"character": 13
}
],
"defaultValue": "\"timestamptz\""
},
{
"id": 349,
"name": "timetz",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 29,
"character": 8
}
],
"defaultValue": "\"timetz\""
},
{
"id": 350,
"name": "tsrange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 30,
"character": 9
}
],
"defaultValue": "\"tsrange\""
},
{
"id": 351,
"name": "tstzrange",
"kind": 16,
"kindString": "Enumeration member",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 31,
"character": 11
}
],
"defaultValue": "\"tstzrange\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344,
345, 346, 347, 348, 349, 350, 351
]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 8,
"character": 25
}
]
},
{
"id": 352,
"name": "Column",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 34,
"character": 11
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 353,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 354,
"name": "flags",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 35,
"character": 7
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 355,
"name": "name",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 36,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 356,
"name": "type",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 37,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 357,
"name": "type_modifier",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 38,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [354, 355, 356, 357]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 34,
"character": 13
}
]
}
}
},
{
"id": 358,
"name": "Records",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 41,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 359,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 360,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 361,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 41,
"character": 14
}
]
}
}
},
{
"id": 378,
"name": "convertCell",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "If the value of the cell is `null`, returns null.\nOtherwise converts the string value to the correct type.",
"tags": [
{
"tag": "example",
"text": "convertCell('bool', 'true')\n//=> true"
},
{
"tag": "example",
"text": "convertCell('int8', '10')\n//=> 10"
},
{
"tag": "example",
"text": "convertCell('_int4', '{1,2,3,4}')\n//=> [1,2,3,4]\n"
}
]
},
"signatures": [
{
"id": 379,
"name": "convertCell",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "If the value of the cell is `null`, returns null.\nOtherwise converts the string value to the correct type.",
"tags": [
{
"tag": "example",
"text": "convertCell('bool', 'true')\n//=> true"
},
{
"tag": "example",
"text": "convertCell('int8', '10')\n//=> 10"
},
{
"tag": "example",
"text": "convertCell('_int4', '{1,2,3,4}')\n//=> [1,2,3,4]\n"
}
]
},
"parameters": [
{
"id": 380,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "A postgres column type"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 381,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The cell value\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 112,
"character": 24
}
]
},
{
"id": 362,
"name": "convertChangeData",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Takes an array of columns and an object of string values then converts each string value\nto its mapped type.",
"tags": [
{
"tag": "example",
"text": "convertChangeData([{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age:'33'}, {})\n//=>{ first_name: 'Paul', age: 33 }\n"
}
]
},
"signatures": [
{
"id": 363,
"name": "convertChangeData",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Takes an array of columns and an object of string values then converts each string value\nto its mapped type.",
"tags": [
{
"tag": "example",
"text": "convertChangeData([{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], {first_name: 'Paul', age:'33'}, {})\n//=>{ first_name: 'Paul', age: 33 }\n"
}
]
},
"parameters": [
{
"id": 364,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 352,
"name": "Column"
}
}
},
{
"id": 365,
"name": "records",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {},
"type": {
"type": "reference",
"id": 358,
"name": "Records"
}
},
{
"id": 366,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The map of various options that can be applied to the mapper"
},
"type": {
"type": "reflection",
"declaration": {
"id": 367,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 368,
"name": "skipTypes",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 60,
"character": 22
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [368]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 60,
"character": 10
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 369,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 370,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 371,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 57,
"character": 30
}
]
},
{
"id": 372,
"name": "convertColumn",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Converts the value of an individual column.",
"returns": "Useless information\n",
"tags": [
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], [])\n//=> 33"
},
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], ['int4'])\n//=> \"33\"\n"
}
]
},
"signatures": [
{
"id": 373,
"name": "convertColumn",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Converts the value of an individual column.",
"returns": "Useless information\n",
"tags": [
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], [])\n//=> 33"
},
{
"tag": "example",
"text": "convertColumn('age', [{name: 'first_name', type: 'text'}, {name: 'age', type: 'int4'}], ['Paul', '33'], ['int4'])\n//=> \"33\"\n"
}
]
},
"parameters": [
{
"id": 374,
"name": "columnName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The column that you want to convert"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 375,
"name": "columns",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 352,
"name": "Column"
}
}
},
{
"id": 376,
"name": "records",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "The map of string values"
},
"type": {
"type": "reference",
"id": 358,
"name": "Records"
}
},
{
"id": 377,
"name": "skipTypes",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"shortText": "An array of types that should not be converted"
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 85,
"character": 26
}
]
},
{
"id": 382,
"name": "noop",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 383,
"name": "noop",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 384,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 183,
"character": 10
}
]
},
{
"id": 406,
"name": "toArray",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Converts a Postgres Array into a native JS array",
"tags": [
{
"tag": "example",
"text": "toArray('{1,2,3,4}', 'int4')\n//=> [1,2,3,4]"
},
{
"tag": "example",
"text": "toArray('{}', 'int4')\n//=> []\n"
}
]
},
"signatures": [
{
"id": 407,
"name": "toArray",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Converts a Postgres Array into a native JS array",
"tags": [
{
"tag": "example",
"text": "toArray('{1,2,3,4}', 'int4')\n//=> [1,2,3,4]"
},
{
"tag": "example",
"text": "toArray('{}', 'int4')\n//=> []\n"
}
]
},
"parameters": [
{
"id": 408,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 409,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 225,
"character": 20
}
]
},
{
"id": 385,
"name": "toBoolean",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 386,
"name": "toBoolean",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 387,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "null"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 186,
"character": 22
}
]
},
{
"id": 388,
"name": "toDate",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 389,
"name": "toDate",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 390,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"name": "Date"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 196,
"character": 19
}
]
},
{
"id": 391,
"name": "toDateRange",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 392,
"name": "toDateRange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 393,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"name": "Date"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 199,
"character": 24
}
]
},
{
"id": 394,
"name": "toFloat",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 395,
"name": "toFloat",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 396,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 203,
"character": 20
}
]
},
{
"id": 397,
"name": "toInt",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 398,
"name": "toInt",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 399,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 206,
"character": 18
}
]
},
{
"id": 400,
"name": "toIntRange",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 401,
"name": "toIntRange",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 402,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "number"
}
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 209,
"character": 23
}
]
},
{
"id": 403,
"name": "toJson",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 404,
"name": "toJson",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 405,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 213,
"character": 19
}
]
},
{
"id": 410,
"name": "toTimestampString",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"comment": {
"shortText": "Fixes timestamp to be ISO-8601. Swaps the space between the date and time for a 'T'\nSee https://github.com/supabase/supabase/issues/18",
"tags": [
{
"tag": "example",
"text": "toTimestampString('2019-09-10 00:00:00')\n//=> '2019-09-10T00:00:00'\n"
}
]
},
"signatures": [
{
"id": 411,
"name": "toTimestampString",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Fixes timestamp to be ISO-8601. Swaps the space between the date and time for a 'T'\nSee https://github.com/supabase/supabase/issues/18",
"tags": [
{
"tag": "example",
"text": "toTimestampString('2019-09-10 00:00:00')\n//=> '2019-09-10T00:00:00'\n"
}
]
},
"parameters": [
{
"id": 412,
"name": "stringValue",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 246,
"character": 30
}
]
}
],
"groups": [
{
"title": "Enumerations",
"kind": 4,
"children": [328]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [352, 358]
},
{
"title": "Functions",
"kind": 64,
"children": [378, 362, 372, 382, 406, 385, 388, 391, 394, 397, 400, 403, 410]
}
],
"sources": [
{
"fileName": "lib/transformers.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [194, 90, 413, 1, 38, 169, 24, 327]
}
]
},
{
"id": 0,
"name": "@supabase/storage-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 231,
"name": "\"SupabaseStorageClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/SupabaseStorageClient.ts",
"children": [
{
"id": 232,
"name": "SupabaseStorageClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 233,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 234,
"name": "new SupabaseStorageClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 235,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 236,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 237,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 238,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 239,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 4,
"character": 35
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 232,
"name": "SupabaseStorageClient"
},
"overwrites": {
"type": "reference",
"id": 93,
"name": "StorageBucketApi.__constructor"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 3,
"character": 61
}
],
"overwrites": {
"type": "reference",
"id": 93,
"name": "StorageBucketApi.__constructor"
}
},
{
"id": 244,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 245,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 246,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 247,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 20
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 89,
"name": "StorageBucketApi.headers"
}
},
{
"id": 243,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 88,
"name": "StorageBucketApi.url"
}
},
{
"id": 259,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 260,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 261,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 263,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 264,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 70
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [263, 264]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 42
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 111,
"name": "StorageBucketApi.createBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 20
}
],
"inheritedFrom": {
"type": "reference",
"id": 111,
"name": "StorageBucketApi.createBucket"
}
},
{
"id": 273,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 274,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 275,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 276,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 277,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 278,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 279,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [279]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 280,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [277, 280]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 13
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 125,
"name": "StorageBucketApi.deleteBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 76,
"character": 20
}
],
"inheritedFrom": {
"type": "reference",
"id": 125,
"name": "StorageBucketApi.deleteBucket"
}
},
{
"id": 265,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 266,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 267,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 268,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 269,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 270,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 271,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [271]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 272,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [269, 272]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 13
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 117,
"name": "StorageBucketApi.emptyBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 59,
"character": 19
}
],
"inheritedFrom": {
"type": "reference",
"id": 117,
"name": "StorageBucketApi.emptyBucket"
}
},
{
"id": 240,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 241,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform file operation in a bucket."
},
"parameters": [
{
"id": 242,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The bucket id to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 137,
"name": "StorageFileApi"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 13,
"character": 6
}
]
},
{
"id": 253,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 254,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 255,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 256,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 257,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "Bucket"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 258,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 67
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [257, 258]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 39
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "StorageBucketApi.getBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 17
}
],
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "StorageBucketApi.getBucket"
}
},
{
"id": 248,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 249,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing product."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 250,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 251,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 252,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 61
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [251, 252]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 31
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 100,
"name": "StorageBucketApi.listBuckets"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 19
}
],
"inheritedFrom": {
"type": "reference",
"id": 100,
"name": "StorageBucketApi.listBuckets"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [233]
},
{
"title": "Properties",
"kind": 1024,
"children": [244, 243]
},
{
"title": "Methods",
"kind": 2048,
"children": [259, 273, 265, 240, 253, 248]
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 3,
"character": 34
}
],
"extendedTypes": [
{
"type": "reference",
"id": 87,
"name": "StorageBucketApi"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [232]
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 281,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/index.ts",
"children": [
{
"id": 282,
"name": "Bucket",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 58
},
{
"id": 283,
"name": "FileObject",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 64
},
{
"id": 285,
"name": "FileOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 78
},
{
"id": 287,
"name": "Metadata",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 84
},
{
"id": 286,
"name": "SearchOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 80
},
{
"id": 284,
"name": "SortBy",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 75
}
],
"groups": [
{
"title": "References",
"kind": 16777216,
"children": [282, 283, 285, 287, 286, 284]
}
],
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 86,
"name": "\"lib/StorageBucketApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageBucketApi.ts",
"children": [
{
"id": 87,
"name": "StorageBucketApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 93,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 94,
"name": "new StorageBucketApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 95,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 96,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 97,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 98,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 99,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 8,
"character": 35
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 87,
"name": "StorageBucketApi"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 46
}
]
},
{
"id": 89,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 90,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 91,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 92,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 20
}
]
}
}
},
{
"id": 88,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 111,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 112,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 113,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 114,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 115,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 116,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 70
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [115, 116]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 42
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 20
}
]
},
{
"id": 125,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 126,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 127,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 128,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 129,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 130,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 131,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [131]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 132,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [129, 132]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 76,
"character": 20
}
]
},
{
"id": 117,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 118,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 119,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 120,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 121,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 122,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 123,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [123]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 124,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [121, 124]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 59,
"character": 19
}
]
},
{
"id": 105,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 106,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 107,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 109,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "Bucket"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 110,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 67
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [109, 110]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 39
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 17
}
]
},
{
"id": 100,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 101,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing product."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 102,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 103,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 104,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 61
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [103, 104]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 31
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 19
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [93]
},
{
"title": "Properties",
"kind": 1024,
"children": [89, 88]
},
{
"title": "Methods",
"kind": 2048,
"children": [111, 125, 117, 105, 100]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 4,
"character": 29
}
],
"extendedBy": [
{
"type": "reference",
"id": 232,
"name": "SupabaseStorageClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [87]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 136,
"name": "\"lib/StorageFileApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageFileApi.ts",
"children": [
{
"id": 137,
"name": "StorageFileApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 144,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 145,
"name": "new StorageFileApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 146,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 147,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 148,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 149,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 150,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 23,
"character": 35
}
]
}
},
"defaultValue": "{}"
},
{
"id": 151,
"name": "bucketId",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"id": 137,
"name": "StorageFileApi"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 21,
"character": 29
}
]
},
{
"id": 143,
"name": "bucketId",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 21,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 139,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 20,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 140,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 141,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 142,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 20,
"character": 20
}
]
}
}
},
{
"id": 138,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 19,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 211,
"name": "_getFinalPath",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 212,
"name": "_getFinalPath",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 213,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 254,
"character": 15
}
]
},
{
"id": 181,
"name": "createSignedUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 182,
"name": "createSignedUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Create signed url to download file without requiring permissions. This URL can be valid for a set number of seconds."
},
"parameters": [
{
"id": 183,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The file path to be downloaded, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 184,
"name": "expiresIn",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute.\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 186,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 187,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 188,
"name": "signedURL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [188]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 189,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 144,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 190,
"name": "signedURL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 145,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [186, 189, 190]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 142,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 139,
"character": 23
}
]
},
{
"id": 191,
"name": "download",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 192,
"name": "download",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Downloads a file."
},
"parameters": [
{
"id": 193,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The file path to be downloaded, including the path and file name. For example `folder/image.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 194,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 195,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 46
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Blob"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 196,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 66
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [195, 196]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 40
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 16
}
]
},
{
"id": 203,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 204,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Lists all the files within a bucket."
},
"parameters": [
{
"id": 205,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The folder path."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 206,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Search options, including `limit`, `offset`, and `sortBy`."
},
"type": {
"type": "reference",
"id": 80,
"name": "SearchOptions"
}
},
{
"id": 207,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Fetch parameters, currently only supports `signal`, which is an AbortController's signal\n"
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 208,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 209,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 64,
"name": "FileObject"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 210,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [209, 210]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 235,
"character": 12
}
]
},
{
"id": 172,
"name": "move",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 173,
"name": "move",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Moves an existing file, optionally renaming it at the same time."
},
"parameters": [
{
"id": 174,
"name": "fromPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The original file path, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 175,
"name": "toPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "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": "reflection",
"declaration": {
"id": 176,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 177,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 178,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 179,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [179]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 180,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [177, 180]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 117,
"character": 12
}
]
},
{
"id": 197,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 198,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Deletes files within the same bucket"
},
"parameters": [
{
"id": 199,
"name": "paths",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "An array of files to be deletes, 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": "reflection",
"declaration": {
"id": 200,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 201,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 64,
"name": "FileObject"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 202,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 75
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [201, 202]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 41
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 14
}
]
},
{
"id": 162,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 163,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Replaces an existing file at the specified path with a new one."
},
"parameters": [
{
"id": 164,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The relative file path. Should be of the format `folder/subfolder`. The bucket already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 165,
"name": "file",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The file object to be stored in the bucket."
},
"type": {
"type": "reference",
"name": "File"
}
},
{
"id": 166,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "HTTP headers. For example `cacheControl`\n"
},
"type": {
"type": "reference",
"id": 78,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 167,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 168,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 169,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 170,
"name": "Key",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [170]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 171,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 50
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [168, 171]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 77,
"character": 14
}
]
},
{
"id": 152,
"name": "upload",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 153,
"name": "upload",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Uploads a file to an existing bucket."
},
"parameters": [
{
"id": 154,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 155,
"name": "file",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The File object to be stored in the bucket."
},
"type": {
"type": "reference",
"name": "File"
}
},
{
"id": 156,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "HTTP headers. For example `cacheControl`\n"
},
"type": {
"type": "reference",
"id": 78,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 157,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 158,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 159,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 160,
"name": "Key",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [160]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 161,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 50
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [158, 161]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 36,
"character": 14
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [144]
},
{
"title": "Properties",
"kind": 1024,
"children": [143, 139, 138]
},
{
"title": "Methods",
"kind": 2048,
"children": [211, 181, 191, 203, 172, 197, 162, 152]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 18,
"character": 27
}
]
},
{
"id": 220,
"name": "DEFAULT_FILE_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 221,
"name": "cacheControl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"3600\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [221]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 14,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 214,
"name": "DEFAULT_SEARCH_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 215,
"name": "limit",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 6,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "100"
},
{
"id": 216,
"name": "offset",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 7,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 217,
"name": "sortBy",
"kind": 2097152,
"kindString": "Object literal",
"flags": {},
"children": [
{
"id": 218,
"name": "column",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 9,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"name\""
},
{
"id": 219,
"name": "order",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 10,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"asc\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [218, 219]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 8,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [215, 216]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [217]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 5,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [137]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [220, 214]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/fetch\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/fetch.ts",
"children": [
{
"id": 2,
"name": "FetchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 3,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 4,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 4,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 5,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 6,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 7,
"name": "noResolveJson",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 7,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [3, 7]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 3,
"character": 29
}
]
},
{
"id": 8,
"name": "FetchParameters",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 9,
"name": "signal",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 11,
"character": 8
}
],
"type": {
"type": "reference",
"name": "AbortSignal"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [9]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 10,
"character": 32
}
]
},
{
"id": 10,
"name": "RequestMethodType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 14,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PUT"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 11,
"name": "_getErrorMessage",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 12,
"name": "_getErrorMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 13,
"name": "err",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 16,
"character": 22
}
]
},
{
"id": 18,
"name": "_getRequestParams",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 19,
"name": "_getRequestParams",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 20,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 10,
"name": "RequestMethodType"
}
},
{
"id": 21,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 22,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
},
{
"id": 23,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 24,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 25,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 26,
"name": "k",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 31,
"character": 23
}
]
},
{
"id": 27,
"name": "_handleRequest",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 28,
"name": "_handleRequest",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 29,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 10,
"name": "RequestMethodType"
}
},
{
"id": 30,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 31,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 32,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
},
{
"id": 33,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 48,
"character": 29
}
]
},
{
"id": 34,
"name": "get",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "get",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 36,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 37,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 38,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 67,
"character": 25
}
]
},
{
"id": 14,
"name": "handleError",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 15,
"name": "handleError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 16,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 17,
"name": "reject",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 19,
"character": 17
}
]
},
{
"id": 39,
"name": "post",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 40,
"name": "post",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 41,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 42,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 43,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 44,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 75,
"character": 26
}
]
},
{
"id": 45,
"name": "put",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 46,
"name": "put",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 47,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 49,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 50,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 84,
"character": 25
}
]
},
{
"id": 51,
"name": "remove",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 52,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 53,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 54,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 55,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 56,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 93,
"character": 28
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [2, 8]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [10]
},
{
"title": "Functions",
"kind": 64,
"children": [11, 18, 27, 34, 14, 39, 45, 51]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 133,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/helpers.ts",
"children": [
{
"id": 134,
"name": "isBrowser",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 135,
"name": "isBrowser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 22
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [134]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 222,
"name": "\"lib/index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/index.ts",
"children": [
{
"id": 225,
"name": "Bucket",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 58
},
{
"id": 226,
"name": "FileObject",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 64
},
{
"id": 228,
"name": "FileOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 78
},
{
"id": 230,
"name": "Metadata",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 84
},
{
"id": 229,
"name": "SearchOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 80
},
{
"id": 227,
"name": "SortBy",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 75
},
{
"id": 223,
"name": "StorageBucketApi",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 87
},
{
"id": 224,
"name": "StorageFileApi",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 137
}
],
"groups": [
{
"title": "References",
"kind": 16777216,
"children": [225, 226, 228, 230, 229, 227, 223, 224]
}
],
"sources": [
{
"fileName": "lib/index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 57,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/types.ts",
"children": [
{
"id": 58,
"name": "Bucket",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 62,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 5,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 59,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 2,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 3,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 61,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 4,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 63,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 6,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [62, 59, 60, 61, 63]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 23
}
]
},
{
"id": 64,
"name": "FileObject",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 66,
"name": "bucket_id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 11,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 74,
"name": "buckets",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 18,
"character": 9
}
],
"type": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"id": 70,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 15,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 68,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 13,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 71,
"name": "last_accessed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 16,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 72,
"name": "metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 17,
"character": 10
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 73,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 17,
"character": 11
}
]
}
}
},
{
"id": 65,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 67,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 69,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [66, 74, 70, 68, 71, 72, 65, 67, 69]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 9,
"character": 27
}
]
},
{
"id": 78,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 79,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [79]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 28
}
]
},
{
"id": 84,
"name": "Metadata",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 85,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [85]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 25
}
]
},
{
"id": 80,
"name": "SearchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 81,
"name": "limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The number of files you want to be returned."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 32,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 82,
"name": "offset",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The starting position."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 35,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 83,
"name": "sortBy",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The column to sort by. Can be any column inside a FileObject."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 8
}
],
"type": {
"type": "reference",
"id": 75,
"name": "SortBy"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [81, 82, 83]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 30,
"character": 30
}
]
},
{
"id": 75,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 76,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 77,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 23,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [76, 77]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 23
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [58, 64, 78, 84, 80, 75]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [231, 281, 86, 136, 1, 133, 222, 57]
}
]
}
]
}
Reference in new issue View Git Blame Copy Permalink