{ "name": "Combined Specs", "children": [ { "id": 0, "name": "@supabase/supabase-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 248, "name": "\"SupabaseClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/SupabaseClient.ts", "children": [ { "id": 249, "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": 257, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Create a new client for use in the browser." }, "signatures": [ { "id": 260, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Create a new client for use in the browser." }, "parameters": [ { "id": 261, "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": 262, "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": 263, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 5, "name": "SupabaseClientOptions" } } ], "type": { "type": "reference", "id": 249, "name": "SupabaseClient" } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 34, "character": 36 } ] }, { "id": 250, "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": 28, "name": "SupabaseAuthClient" } }, { "id": 254, "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": 256, "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": 253, "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": 252, "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": 251, "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": 255, "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": 259, "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": 49, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 258, "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": 48, "character": 25 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 264, "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": 265, "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": 74, "character": 13 } ] }, { "id": 301, "name": "_closeChannel", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 302, "name": "_closeChannel", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 303, "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": 180, "character": 23 } ] }, { "id": 278, "name": "_closeSubscription", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 279, "name": "_closeSubscription", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 280, "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": 126, "character": 34 } ] }, { "id": 296, "name": "_getAuthHeaders", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 297, "name": "_getAuthHeaders", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 298, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 299, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 300, "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": 172, "character": 28 } ] } } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 172, "character": 25 } ] }, { "id": 294, "name": "_initPostgRESTClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 295, "name": "_initPostgRESTClient", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "type": { "type": "reference", "name": "PostgrestClient" } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 165, "character": 30 } ] }, { "id": 291, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 292, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 293, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "name": "RealtimeClientOptions" } } ], "type": { "type": "reference", "name": "RealtimeClient" } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 158, "character": 29 } ] }, { "id": 283, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 284, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 285, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 287, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 140, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 289, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 142, "character": 22 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 290, "name": "localStorage", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 143, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "name": "Storage" } ] } }, { "id": 288, "name": "persistSession", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 141, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 287, 289, 290, 288 ] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 139, "character": 34 } ] } } } ], "type": { "type": "reference", "id": 28, "name": "SupabaseAuthClient" } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 139, "character": 33 } ] }, { "id": 266, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 267, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a table operation." }, "typeParameter": [ { "id": 268, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 269, "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": 158, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "SupabaseQueryBuilder" } } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 83, "character": 6 } ] }, { "id": 281, "name": "getSubscriptions", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "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": 135, "character": 18 } ] }, { "id": 275, "name": "removeSubscription", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 276, "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": 277, "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": 109, "character": 20 } ] }, { "id": 270, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 271, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a stored procedure call." }, "typeParameter": [ { "id": 272, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 273, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The function name to call." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 274, "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": 99, "character": 5 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 257 ] }, { "title": "Properties", "kind": 1024, "children": [ 250, 254, 256, 253, 252, 251, 255, 259, 258 ] }, { "title": "Accessors", "kind": 262144, "children": [ 264 ] }, { "title": "Methods", "kind": 2048, "children": [ 301, 278, 296, 294, 291, 283, 266, 281, 275, 270 ] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 23, "character": 35 } ] }, { "id": 304, "name": "DEFAULT_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 306, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 11, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 308, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 13, "character": 20 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 310, "name": "headers", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 15, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 311, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 309, "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": 307, "name": "persistSession", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 12, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 305, "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": [ 306, 308, 310, 309, 307, 305 ] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 9, "character": 21 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 249 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 304 ] } ], "sources": [ { "fileName": "src/SupabaseClient.ts", "line": 1, "character": 0 } ] }, { "id": 312, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/index.ts", "children": [ { "id": 313, "name": "createClient", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "comment": { "shortText": "Creates a new Supabase Client." }, "signatures": [ { "id": 314, "name": "createClient", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Creates a new Supabase Client." }, "parameters": [ { "id": 315, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 316, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 317, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "reference", "id": 5, "name": "SupabaseClientOptions" } } ], "type": { "type": "reference", "id": 249, "name": "SupabaseClient" } } ], "sources": [ { "fileName": "src/index.ts", "line": 16, "character": 18 } ] } ], "groups": [ { "title": "Functions", "kind": 64, "children": [ 313 ] } ], "sources": [ { "fileName": "src/index.ts", "line": 1, "character": 0 } ] }, { "id": 27, "name": "\"lib/SupabaseAuthClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseAuthClient.ts", "children": [ { "id": 28, "name": "SupabaseAuthClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 29, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 30, "name": "new SupabaseAuthClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 31, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 32, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 39, "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": 38, "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": 34, "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": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 36, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 37, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 41, "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": 40, "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": 33, "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": [ 39, 38, 34, 41, 40, 33 ] } ], "sources": [ { "fileName": "src/lib/SupabaseAuthClient.ts", "line": 4, "character": 22 } ] } } } ], "type": { "type": "reference", "id": 28, "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": 42, "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": 42, "name": "GoTrueClient.api" } }, { "id": 45, "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": 45, "name": "GoTrueClient.autoRefreshToken" } }, { "id": 44, "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": 44, "name": "GoTrueClient.currentSession" } }, { "id": 43, "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": 43, "name": "GoTrueClient.currentUser" } }, { "id": 47, "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": 47, "name": "GoTrueClient.localStorage" } }, { "id": 46, "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": 46, "name": "GoTrueClient.persistSession" } }, { "id": 49, "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": 49, "name": "GoTrueClient.refreshTokenTimer" } }, { "id": 48, "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": 48, "name": "GoTrueClient.stateChangeEmitters" } }, { "id": 109, "name": "getSessionFromUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 110, "name": "getSessionFromUrl", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the session data from a URL string" }, "parameters": [ { "id": 111, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 112, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 113, "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": 122, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 113 ] } ] } } ] } } ], "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": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 124, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 116, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 125, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 115, 116 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 123, "character": 16 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 109, "name": "GoTrueClient.getSessionFromUrl" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 121, "character": 21 } ], "inheritedFrom": { "type": "reference", "id": 109, "name": "GoTrueClient.getSessionFromUrl" } }, { "id": 121, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 122, "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": 123, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 125, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 126, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "AuthChangeEvent" } }, { "id": 127, "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": 140, "character": 31 } ] } } } ], "type": { "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": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 141, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Subscription" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 130, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 142, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 129, 130 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 140, "character": 91 } ] } }, "inheritedFrom": { "type": "reference", "id": 121, "name": "GoTrueClient.onAuthStateChange" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 140, "character": 21 } ], "inheritedFrom": { "type": "reference", "id": 121, "name": "GoTrueClient.onAuthStateChange" } }, { "id": 87, "name": "refreshSession", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 88, "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": 89, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 90, "name": "data", "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": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 92, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 94, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 91, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 93, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 90, 92, 91 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 91, "character": 30 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 87, "name": "GoTrueClient.refreshSession" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 91, "character": 18 } ], "inheritedFrom": { "type": "reference", "id": 87, "name": "GoTrueClient.refreshSession" } }, { "id": 85, "name": "session", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 86, "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": 85, "name": "GoTrueClient.session" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 87, "character": 11 } ], "inheritedFrom": { "type": "reference", "id": 85, "name": "GoTrueClient.session" } }, { "id": 106, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 107, "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": 108, "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": 106, "name": "GoTrueClient.setAuth" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 116, "character": 11 } ], "inheritedFrom": { "type": "reference", "id": 106, "name": "GoTrueClient.setAuth" } }, { "id": 100, "name": "setSession", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 101, "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": 102, "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": 103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 105, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 110, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 104, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 109, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 105, 104 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 108, "character": 47 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 100, "name": "GoTrueClient.setSession" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 108, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 100, "name": "GoTrueClient.setSession" } }, { "id": 64, "name": "signIn", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 65, "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": 66, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 67, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 68, "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": 67, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 69, "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": 67, "character": 28 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 71, "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": 67, "character": 52 } ], "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" }, { "type": "stringLiteral", "value": "twitter" }, { "type": "stringLiteral", "value": "apple" }, { "type": "stringLiteral", "value": "discord" } ] } }, { "id": 70, "name": "refreshToken", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "A valid refresh token that was returned on login." }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 67, "character": 42 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 68, 69, 71, 70 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 67, "character": 11 } ] } } }, { "id": 72, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 73, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 74, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 68, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 75, "name": "scopes", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 69, "character": 14 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 74, 75 ] } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 76, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 82, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 76, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 81, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 75, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 79, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 73, "character": 16 } ], "type": { "type": "reference", "name": "Provider" } }, { "id": 77, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 71, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 80, "name": "url", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 74, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 78, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 72, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 82, 81, 79, 77, 80, 78 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 70, "character": 16 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 64, "name": "GoTrueClient.signIn" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 67, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 64, "name": "GoTrueClient.signIn" } }, { "id": 117, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 118, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Inside a browser context, `signOut()` will remove extract 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": 119, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 120, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 134, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 120 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 133, "character": 23 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 117, "name": "GoTrueClient.signOut" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 133, "character": 11 } ], "inheritedFrom": { "type": "reference", "id": 117, "name": "GoTrueClient.signOut" } }, { "id": 50, "name": "signUp", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 51, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Creates a new user." }, "parameters": [ { "id": 52, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 53, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 54, "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": 55, "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": [ 54, 55 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 49, "character": 11 } ] } } }, { "id": 56, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 57, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 58, "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": [ 58 ] } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 63, "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": 62, "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": 61, "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": 60, "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": [ 63, 62, 61, 60 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 51, "character": 16 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 50, "name": "GoTrueClient.signUp" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 49, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 50, "name": "GoTrueClient.signUp" } }, { "id": 93, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 94, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates user data, if there is a logged in user." }, "parameters": [ { "id": 95, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "UserAttributes" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 96, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 97, "name": "data", "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" } ] } }, { "id": 99, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 102, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 98, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 101, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 97, 99, 98 ] } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 99, "character": 48 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 93, "name": "GoTrueClient.update" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 99, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 93, "name": "GoTrueClient.update" } }, { "id": 83, "name": "user", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 84, "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": 83, "name": "GoTrueClient.user" } } ], "sources": [ { "fileName": "node_modules/@supabase/gotrue-js/dist/main/GoTrueClient.d.ts", "line": 83, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 83, "name": "GoTrueClient.user" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 29 ] }, { "title": "Properties", "kind": 1024, "children": [ 42, 45, 44, 43, 47, 46, 49, 48 ] }, { "title": "Methods", "kind": 2048, "children": [ 109, 121, 87, 85, 106, 100, 64, 117, 50, 93, 83 ] } ], "sources": [ { "fileName": "src/lib/SupabaseAuthClient.ts", "line": 3, "character": 31 } ], "extendedTypes": [ { "type": "reference", "name": "GoTrueClient" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 28 ] } ], "sources": [ { "fileName": "src/lib/SupabaseAuthClient.ts", "line": 1, "character": 0 } ] }, { "id": 157, "name": "\"lib/SupabaseQueryBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseQueryBuilder.ts", "children": [ { "id": 158, "name": "SupabaseQueryBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 159, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 162, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 163, "name": "new SupabaseQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 164, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 165, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 166, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 167, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 13, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 169, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 170, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 172, "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": 171, "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": 173, "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": [ 167, 172, 171, 173 ] } ], "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 11, "character": 16 } ] } } } ], "type": { "type": "reference", "id": 158, "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": 161, "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": 160, "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": 132, "name": "SupabaseRealtimeClient" } }, { "id": 232, "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": 48, "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": 232, "name": "PostgrestBuilder.body" } }, { "id": 227, "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": 44, "character": 21 } ], "type": { "type": "reflection", "declaration": { "id": 228, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 229, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 230, "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": 44, "character": 22 } ] } }, "inheritedFrom": { "type": "reference", "id": 227, "name": "PostgrestBuilder.headers" } }, { "id": 225, "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": 42, "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": 225, "name": "PostgrestBuilder.method" } }, { "id": 231, "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": 47, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 231, "name": "PostgrestBuilder.schema" } }, { "id": 233, "name": "shouldThrowOnError", "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": 49, "character": 32 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 233, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 226, "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": 43, "character": 17 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 226, "name": "PostgrestBuilder.url" } }, { "id": 219, "name": "delete", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 220, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs a DELETE on the table." }, "parameters": [ { "id": 221, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 222, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 224, "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": 73, "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": 223, "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": 73, "character": 22 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 224, 223 ] } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 73, "character": 11 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 219, "name": "PostgrestQueryBuilder.delete" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 73, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 219, "name": "PostgrestQueryBuilder.delete" } }, { "id": 188, "name": "insert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 189, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an INSERT into the table." }, "parameters": [ { "id": 190, "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": 191, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 194, "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": 193, "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": [ 194, 193 ] } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 188, "name": "PostgrestQueryBuilder.insert" } }, { "id": 195, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `upsert()` instead.\n" } ] }, "parameters": [ { "id": 196, "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": 197, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 198, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 202, "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": 200, "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": 201, "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": 199, "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": [ 202, 200, 201, 199 ] } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 188, "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": 188, "name": "PostgrestQueryBuilder.insert" } }, { "id": 174, "name": "on", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 175, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Subscribe to realtime changes in your databse." }, "parameters": [ { "id": 176, "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": 26, "name": "SupabaseEventTypes" } }, { "id": 177, "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": 178, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 179, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 180, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 17, "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": 132, "name": "SupabaseRealtimeClient" } } ], "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 35, "character": 4 } ] }, { "id": 181, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 182, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 183, "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": 184, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 187, "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": 186, "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": [ 187, 186 ] } ], "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": 181, "name": "PostgrestQueryBuilder.select" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 17, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 181, "name": "PostgrestQueryBuilder.select" } }, { "id": 236, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 237, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 238, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 239, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 240, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 242, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 243, "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": 58, "character": 75 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 244, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 246, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 247, "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": 58, "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": 236, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts", "line": 58, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 236, "name": "PostgrestBuilder.then" } }, { "id": 234, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 235, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 234, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/types.d.ts", "line": 57, "character": 16 } ], "inheritedFrom": { "type": "reference", "id": 234, "name": "PostgrestBuilder.throwOnError" } }, { "id": 212, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 213, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPDATE on the table." }, "parameters": [ { "id": 214, "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": 215, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "originalName": "__1", "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": 63, "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": 217, "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": 63, "character": 42 } ], "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": 63, "character": 30 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 212, "name": "PostgrestQueryBuilder.update" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 63, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 212, "name": "PostgrestQueryBuilder.update" } }, { "id": 203, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 204, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPSERT into the table." }, "parameters": [ { "id": 205, "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": 206, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 207, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 210, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table." }, "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 50, "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": 211, "name": "ignoreDuplicates", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Specifies if duplicate rows should be ignored and not inserted.\n" }, "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 50, "character": 94 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 208, "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": 50, "character": 58 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 209, "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": 50, "character": 69 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 210, 211, 208, 209 ] } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 50, "character": 45 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 203, "name": "PostgrestQueryBuilder.upsert" } } ], "sources": [ { "fileName": "node_modules/@supabase/postgrest-js/dist/main/lib/PostgrestQueryBuilder.d.ts", "line": 50, "character": 10 } ], "inheritedFrom": { "type": "reference", "id": 203, "name": "PostgrestQueryBuilder.upsert" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 162 ] }, { "title": "Properties", "kind": 1024, "children": [ 161, 160, 232, 227, 225, 231, 233, 226 ] }, { "title": "Methods", "kind": 2048, "children": [ 219, 188, 174, 181, 236, 234, 212, 203 ] } ], "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": [ 158 ] } ], "sources": [ { "fileName": "src/lib/SupabaseQueryBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 131, "name": "\"lib/SupabaseRealtimeClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/SupabaseRealtimeClient.ts", "children": [ { "id": 132, "name": "SupabaseRealtimeClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 134, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 135, "name": "new SupabaseRealtimeClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 136, "name": "socket", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "RealtimeClient" } }, { "id": 137, "name": "schema", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 138, "name": "tableName", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "id": 132, "name": "SupabaseRealtimeClient" } } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 5, "character": 36 } ] }, { "id": 133, "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": 139, "name": "getPayloadRecords", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 140, "name": "getPayloadRecords", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 141, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reflection", "declaration": { "id": 142, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 143, "name": "new", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 14, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 144, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true } } } }, { "id": 145, "name": "old", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 15, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true } } } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 143, 145 ] } ] } } } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 12, "character": 27 } ] }, { "id": 147, "name": "on", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 148, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "The event you want to listen to." }, "parameters": [ { "id": 149, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The event" }, "type": { "type": "reference", "id": 26, "name": "SupabaseEventTypes" } }, { "id": 150, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A callback function that is called whenever the event occurs.\n" }, "type": { "type": "reflection", "declaration": { "id": 151, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 152, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 153, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 17, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "SupabaseRealtimePayload" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 35, "character": 41 } ] } } } ], "type": { "type": "unknown", "name": "this" } } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 35, "character": 4 } ] }, { "id": 154, "name": "subscribe", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 155, "name": "subscribe", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Enables the subscription." }, "parameters": [ { "id": 156, "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": [ 134 ] }, { "title": "Properties", "kind": 1024, "children": [ 133 ] }, { "title": "Methods", "kind": 2048, "children": [ 139, 147, 154 ] } ], "sources": [ { "fileName": "src/lib/SupabaseRealtimeClient.ts", "line": 4, "character": 35 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 132 ] } ], "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": 318, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/supabase-js/supabase-js/src/lib/helpers.ts", "children": [ { "id": 319, "name": "uuid", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 320, "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": [ 319 ] } ], "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": 3, "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": 15, "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": 23, "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": 11, "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": 27, "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": 19, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 16, "name": "realtime", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "Options passed to the realtime-js instance" }, "sources": [ { "fileName": "src/lib/types.ts", "line": 32, "character": 10 } ], "type": { "type": "reference", "name": "RealtimeClientOptions" } }, { "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": 7, "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, 16, 7 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 3, "character": 35 } ] } } }, { "id": 26, "name": "SupabaseEventTypes", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 46, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "INSERT" }, { "type": "stringLiteral", "value": "UPDATE" }, { "type": "stringLiteral", "value": "DELETE" }, { "type": "stringLiteral", "value": "*" } ] } }, { "id": 17, "name": "SupabaseRealtimePayload", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 18, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 35 } ], "type": { "type": "reflection", "declaration": { "id": 19, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 20, "name": "commit_timestamp", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 36, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 21, "name": "eventType", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 37, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "INSERT" }, { "type": "stringLiteral", "value": "UPDATE" }, { "type": "stringLiteral", "value": "DELETE" } ] } }, { "id": 24, "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": 41, "character": 5 } ], "type": { "type": "typeParameter", "name": "T" } }, { "id": 25, "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": 43, "character": 5 } ], "type": { "type": "typeParameter", "name": "T" } }, { "id": 22, "name": "schema", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 38, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 23, "name": "table", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "src/lib/types.ts", "line": 39, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 20, 21, 24, 25, 22, 23 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 35, "character": 40 } ] } } } ], "groups": [ { "title": "Type aliases", "kind": 4194304, "children": [ 5, 26, 17 ] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [ 248, 312, 27, 157, 131, 1, 318, 4 ] } ] }, { "id": 0, "name": "@supabase/gotrue-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 197, "name": "\"GoTrueApi\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueApi.ts", "children": [ { "id": 198, "name": "GoTrueApi", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 205, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 206, "name": "new GoTrueApi", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 207, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 214, "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": 210, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 16, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 211, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 212, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 213, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 209, "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": [ 214, 210, 209 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 14, "character": 14 } ] } } } ], "type": { "type": "reference", "id": 198, "name": "GoTrueApi" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 12, "character": 40 } ] }, { "id": 204, "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": 200, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 9, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 202, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 203, "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": 199, "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": 166, "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": 254, "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": 254, "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": 254, "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": 254, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 251, "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": 103, "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": 198, "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": 199, "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": 197, "character": 12 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 195, "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": 218, "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": 218, "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": 218, "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": 218, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 216, "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": 322, "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": 322, "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": 322, "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": 322, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 320, "character": 23 } ] }, { "id": 245, "name": "inviteUserByEmail", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 246, "name": "inviteUserByEmail", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sends an invite link to an email address." }, "parameters": [ { "id": 247, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 248, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 250, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 121, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 250 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 120, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 251, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 252, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 123, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 58, "name": "User" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 253, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 123, "character": 39 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 252, 253 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 123, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 118, "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": 275, "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": 275, "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": 275, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 273, "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": 235, "name": "sendMagicLinkEmail", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 236, "name": "sendMagicLinkEmail", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Sends a magic login link to an email address." }, "parameters": [ { "id": 237, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 238, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 240, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 97, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 240 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 96, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 241, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 242, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 99, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 243, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 99, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 244, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 99, "character": 37 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 242, 244 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 99, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 94, "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": 294, "character": 15 } ] }, { "id": 225, "name": "signInWithEmail", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 226, "name": "signInWithEmail", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Logs in an existing user using their email address." }, "parameters": [ { "id": 227, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 228, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 229, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 231, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 71, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 231 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 70, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 232, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 233, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 73, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 234, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueApi.ts", "line": 73, "character": 42 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 233, 234 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 73, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 67, "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": 176, "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": 176, "character": 38 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 176, "character": 15 } ] }, { "id": 215, "name": "signUpWithEmail", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 216, "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": 217, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 218, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The password of the user." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 219, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 221, "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": [ 221 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 42, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 222, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 223, "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": 224, "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": [ 223, 224 ] } ], "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": 235, "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": 235, "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": 235, "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": 235, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 232, "character": 18 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 205 ] }, { "title": "Properties", "kind": 1024, "children": [ 204, 200, 199 ] }, { "title": "Methods", "kind": 2048, "children": [ 264, 295, 273, 280, 313, 245, 303, 254, 235, 309, 225, 268, 215, 287 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", "line": 7, "character": 30 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 198 ] } ], "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": 198, "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": 468, "name": "_callRefreshToken", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 469, "name": "_callRefreshToken", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 470, "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": 471, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 472, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 532, "character": 19 } ], "type": { "type": "reference", "id": 50, "name": "Session" } }, { "id": 473, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 532, "character": 26 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 472, 473 ] } ] } }, { "type": "reflection", "declaration": { "id": 474, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 475, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 534, "character": 19 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 476, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 534, "character": 32 } ], "type": { "type": "intrinsic", "name": "any" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 475, 476 ] } ] } } ] } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 520, "character": 33 } ] }, { "id": 428, "name": "_handleEmailSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 429, "name": "_handleEmailSignIn", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 430, "name": "email", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 431, "name": "password", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 432, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 433, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 434, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 411, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 434 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 410, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 435, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 436, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 425, "character": 19 } ], "type": { "type": "reference", "id": 50, "name": "Session" } }, { "id": 439, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 425, "character": 58 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 438, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 425, "character": 45 } ], "type": { "type": "reference", "id": 50, "name": "Session" }, "defaultValue": "data" }, { "id": 437, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 425, "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": [ 436, 439, 438, 437 ] } ] } }, { "type": "reflection", "declaration": { "id": 440, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 441, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 427, "character": 19 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 444, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 427, "character": 59 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 443, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 427, "character": 46 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 442, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 427, "character": 31 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 441, 444, 443, 442 ] } ] } } ] } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 407, "character": 34 } ] }, { "id": 445, "name": "_handleProviderSignIn", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 446, "name": "_handleProviderSignIn", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 447, "name": "provider", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 103, "name": "Provider" } }, { "id": 448, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 449, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 450, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 434, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 451, "name": "scopes", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 435, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 450, 451 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 433, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 452, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 455, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 34 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 458, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 74 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 453, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 23 } ], "type": { "type": "reference", "id": 103, "name": "Provider" } }, { "id": 456, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 49 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 454, "name": "url", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 28 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 457, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 448, "character": 61 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 455, 458, 453, 456, 454, 457 ] } ] } }, { "type": "reflection", "declaration": { "id": 459, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 460, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 452, "character": 19 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 463, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 452, "character": 59 } ], "type": { "type": "intrinsic", "name": "any" } }, { "id": 462, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 452, "character": 46 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" }, { "id": 461, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 452, "character": 31 } ], "type": { "type": "intrinsic", "name": "null" }, "defaultValue": "null" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 460, 463, 462, 461 ] } ] } } ] } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 431, "character": 31 } ] }, { "id": 477, "name": "_notifyAllSubscribers", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 478, "name": "_notifyAllSubscribers", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 479, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 104, "name": "AuthChangeEvent" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 538, "character": 31 } ] }, { "id": 483, "name": "_persistSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 484, "name": "_persistSession", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 485, "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": 565, "character": 25 } ] }, { "id": 466, "name": "_recoverAndRefresh", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 467, "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": 484, "character": 34 } ] }, { "id": 464, "name": "_recoverSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 465, "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": 460, "character": 25 } ] }, { "id": 486, "name": "_removeSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 487, "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": 570, "character": 30 } ] }, { "id": 480, "name": "_saveSession", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 481, "name": "_saveSession", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible" }, "parameters": [ { "id": 482, "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": 546, "character": 22 } ] }, { "id": 488, "name": "_startAutoRefreshToken", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 489, "name": "_startAutoRefreshToken", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Clear and re-create refresh token timer" }, "parameters": [ { "id": 490, "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": 581, "character": 32 } ] }, { "id": 406, "name": "getSessionFromUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 407, "name": "getSessionFromUrl", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Gets the session data from a URL string" }, "parameters": [ { "id": 408, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 410, "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": 317, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 410 ] } ] } } ] } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 412, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 318, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 413, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 318, "character": 43 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 412, 413 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 318, "character": 14 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 316, "character": 25 } ] }, { "id": 418, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 419, "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": 420, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 421, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 422, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 423, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 104, "name": "AuthChangeEvent" } }, { "id": 424, "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": 388, "character": 13 } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 426, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 389, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 82, "name": "Subscription" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 427, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 389, "character": 39 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 426, 427 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 389, "character": 4 } ] } } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 387, "character": 19 } ] }, { "id": 384, "name": "refreshSession", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 385, "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": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 387, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 224, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 389, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 226, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 388, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 225, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 58, "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 387, 389, 388 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 223, "character": 34 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 223, "character": 22 } ] }, { "id": 382, "name": "session", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 383, "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": 216, "character": 9 } ] }, { "id": 403, "name": "setAuth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 404, "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": 405, "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": 301, "character": 9 } ] }, { "id": 397, "name": "setSession", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 398, "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": 399, "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": 400, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 402, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 273, "character": 45 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 401, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 273, "character": 22 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 402, 401 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 273, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 271, "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": 153, "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": 153, "character": 21 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 368, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "One of the providers supported by GoTrue." }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 153, "character": 45 } ], "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" }, { "type": "stringLiteral", "value": "twitter" }, { "type": "stringLiteral", "value": "apple" }, { "type": "stringLiteral", "value": "discord" } ] } }, { "id": 367, "name": "refreshToken", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "A valid refresh token that was returned on login." }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 153, "character": 35 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 365, 366, 368, 367 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 152, "character": 15 } ] } } }, { "id": 369, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 370, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 371, "name": "redirectTo", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 155, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 372, "name": "scopes", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 156, "character": 12 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 371, 372 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 154, "character": 12 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 379, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 164, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 378, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 163, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 376, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 161, "character": 12 } ], "type": { "type": "reference", "id": 103, "name": "Provider" } }, { "id": 374, "name": "session", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 159, "character": 11 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 50, "name": "Session" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 377, "name": "url", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 162, "character": 7 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 375, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 160, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 58, "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 379, 378, 376, 374, 377, 375 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 158, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 152, "character": 14 } ] }, { "id": 414, "name": "signOut", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 415, "name": "signOut", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Inside a browser context, `signOut()` will remove extract 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": 416, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 417, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 372, "character": 34 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 417 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 372, "character": 27 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 372, "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": 390, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 391, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates user data, if there is a logged in user." }, "parameters": [ { "id": 392, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 77, "name": "UserAttributes" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 394, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 246, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 58, "name": "User" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 396, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 246, "character": 58 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 395, "name": "user", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "GoTrueClient.ts", "line": 246, "character": 38 } ], "type": { "type": "union", "types": [ { "type": "reference", "id": 58, "name": "User" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 394, 396, 395 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 246, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 244, "character": 14 } ] }, { "id": 380, "name": "user", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 381, "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": 209, "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": [ 468, 428, 445, 477, 483, 466, 464, 486, 480, 488, 406, 418, 384, 382, 403, 397, 361, 414, 347, 390, 380 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 26, "character": 33 } ] }, { "id": 491, "name": "DEFAULT_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 493, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "GoTrueClient.ts", "line": 20, "character": 18 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 496, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "GoTrueClient.ts", "line": 23, "character": 20 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 497, "name": "headers", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "GoTrueClient.ts", "line": 24, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 498, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {} } }, "defaultValue": "DEFAULT_HEADERS" }, { "id": 495, "name": "localStorage", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "GoTrueClient.ts", "line": 22, "character": 14 } ], "type": { "type": "reference", "name": "Storage" }, "defaultValue": "globalThis.localStorage" }, { "id": 494, "name": "persistSession", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "GoTrueClient.ts", "line": 21, "character": 16 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "true" }, { "id": 492, "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": [ 493, 496, 497, 495, 494, 492 ] } ], "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": [ 491 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", "line": 1, "character": 0 } ] }, { "id": 499, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/index.ts", "children": [ { "id": 501, "name": "AuthChangeEvent", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 104 }, { "id": 506, "name": "CookieOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 92 }, { "id": 500, "name": "Provider", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 103 }, { "id": 502, "name": "Session", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 50 }, { "id": 505, "name": "Subscription", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 82 }, { "id": 503, "name": "User", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 58 }, { "id": 504, "name": "UserAttributes", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 77 }, { "id": 507, "name": "UserCredentials", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 98 } ], "groups": [ { "title": "References", "kind": 16777216, "children": [ 501, 506, 500, 502, 505, 503, 504, 507 ] } ], "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 105, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/constants.ts", "children": [ { "id": 107, "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": 108, "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": 109, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true } } } }, { "id": 110, "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": 106, "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": 111, "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": 112, "name": "COOKIE_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isExported": true, "isConst": true }, "children": [ { "id": 115, "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": 114, "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": 113, "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": 116, "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": 117, "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": [ 115, 114, 113, 116, 117 ] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 6, "character": 27 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 107, 108, 110, 106, 111 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 112 ] } ], "sources": [ { "fileName": "lib/constants.ts", "line": 1, "character": 0 } ] }, { "id": 118, "name": "\"lib/cookies\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/cookies.ts", "children": [ { "id": 119, "name": "Cookie", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 1, "character": 11 } ], "type": { "type": "reflection", "declaration": { "id": 120, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 124, "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": 123, "name": "maxAge", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 4, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 121, "name": "name", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 2, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 125, "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": 126, "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": 122, "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": [ 124, 123, 121, 125, 126, 122 ] } ], "sources": [ { "fileName": "lib/cookies.ts", "line": 1, "character": 13 } ] } } }, { "id": 157, "name": "deleteCookie", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 158, "name": "deleteCookie", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 159, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 160, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 161, "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": 140, "name": "isSecureEnvironment", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 141, "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": 142, "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": 127, "name": "serialize", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 128, "name": "serialize", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Serialize data into a cookie header." }, "parameters": [ { "id": 129, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 130, "name": "val", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 131, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reflection", "declaration": { "id": 132, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { "id": 134, "name": "domain", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 18, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 136, "name": "expires", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 20, "character": 11 } ], "type": { "type": "reference", "name": "Date" } }, { "id": 137, "name": "httpOnly", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 21, "character": 12 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 133, "name": "maxAge", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 17, "character": 10 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 135, "name": "path", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 19, "character": 8 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 139, "name": "sameSite", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/cookies.ts", "line": 23, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 138, "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": [ 134, 136, 137, 133, 135, 139, 138 ] } ], "sources": [ { "fileName": "lib/cookies.ts", "line": 16, "character": 10 } ] } } } ], "type": { "type": "intrinsic", "name": "string" } } ], "sources": [ { "fileName": "lib/cookies.ts", "line": 13, "character": 18 } ] }, { "id": 143, "name": "serializeCookie", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { "id": 144, "name": "serializeCookie", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { "shortText": "Serialize a cookie to a string." }, "parameters": [ { "id": 145, "name": "cookie", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", "id": 119, "name": "Cookie" } }, { "id": 146, "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": 152, "name": "setCookie", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 153, "name": "setCookie", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set one or more cookies." }, "parameters": [ { "id": 154, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 155, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 156, "name": "cookie", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 119, "name": "Cookie" } } ], "type": { "type": "intrinsic", "name": "void" } } ], "sources": [ { "fileName": "lib/cookies.ts", "line": 160, "character": 25 } ] }, { "id": 147, "name": "setCookies", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 148, "name": "setCookies", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set one or more cookies." }, "parameters": [ { "id": 149, "name": "req", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 150, "name": "res", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "any" } }, { "id": 151, "name": "cookies", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 119, "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": [ 119 ] }, { "title": "Functions", "kind": 64, "children": [ 157, 140, 127, 143, 152, 147 ] } ], "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": 162, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/helpers.ts", "children": [ { "id": 163, "name": "LocalStorage", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "indexSignature": [ { "id": 165, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 166, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "children": [ { "id": 168, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 169, "name": "new LocalStorage", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 170, "name": "localStorage", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "name": "Storage" } } ], "type": { "type": "reference", "id": 163, "name": "LocalStorage" } } ], "sources": [ { "fileName": "lib/helpers.ts", "line": 29, "character": 17 } ] }, { "id": 167, "name": "length", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/helpers.ts", "line": 29, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 164, "name": "localStorage", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/helpers.ts", "line": 27, "character": 14 } ], "type": { "type": "reference", "name": "Storage" } }, { "id": 171, "name": "clear", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 172, "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": 180, "name": "getItem", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "getItem", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 182, "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": 173, "name": "key", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 174, "name": "key", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 175, "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": 183, "name": "removeItem", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 184, "name": "removeItem", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 185, "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": 176, "name": "setItem", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 177, "name": "setItem", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 178, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 179, "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": [ 168 ] }, { "title": "Properties", "kind": 1024, "children": [ 167, 164 ] }, { "title": "Methods", "kind": 2048, "children": [ 171, 180, 173, 183, 176 ] } ], "sources": [ { "fileName": "lib/helpers.ts", "line": 26, "character": 25 } ], "implementedTypes": [ { "type": "reference", "name": "Storage" } ] }, { "id": 186, "name": "expiresAt", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 187, "name": "expiresAt", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 188, "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": 193, "name": "getParameterByName", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 194, "name": "getParameterByName", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 195, "name": "name", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 196, "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": 191, "name": "isBrowser", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 192, "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": 189, "name": "uuid", "kind": 64, "kindString": "Function", "flags": { "isExported": true }, "signatures": [ { "id": 190, "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": [ 163 ] }, { "title": "Functions", "kind": 64, "children": [ 186, 193, 191, 189 ] } ], "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": 104, "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": 102, "name": "provider", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 96, "character": 10 } ], "type": { "type": "reference", "id": 103, "name": "Provider" } }, { "id": 101, "name": "refreshToken", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 94, "character": 14 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 99, 100, 102, 101 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 91, "character": 32 } ] }, { "id": 104, "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": 103, "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" }, { "type": "stringLiteral", "value": "twitter" }, { "type": "stringLiteral", "value": "apple" }, { "type": "stringLiteral", "value": "discord" } ] } } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [ 92, 50, 82, 58, 77, 98 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ 104, 103 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [ 197, 323, 499, 105, 118, 1, 162, 320, 49 ] } ] }, { "id": 0, "name": "@supabase/postgrest-js", "kind": 0, "flags": {}, "originalName": "", "children": [ { "id": 443, "name": "\"PostgrestClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/PostgrestClient.ts", "children": [ { "id": 444, "name": "PostgrestClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 451, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "signatures": [ { "id": 452, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "comment": { "shortText": "Creates a PostgREST client." }, "parameters": [ { "id": 453, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "shortText": "URL of the PostgREST endpoint." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 454, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 455, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 456, "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": 457, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 458, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 459, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 460, "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": [ 456, 460 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 18, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 444, "name": "PostgrestClient" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 8, "character": 17 } ] }, { "id": 446, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 7, "character": 9 } ], "type": { "type": "reflection", "declaration": { "id": 447, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 448, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 449, "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": 450, "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": 445, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "PostgrestClient.ts", "line": 6, "character": 5 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 461, "name": "auth", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 462, "name": "auth", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Authenticates the request with JWT." }, "parameters": [ { "id": 463, "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": 464, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 465, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a table operation." }, "typeParameter": [ { "id": 466, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 467, "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": 322, "typeArguments": [ { "type": "typeParameter", "name": "T", "default": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestQueryBuilder" } } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 41, "character": 6 } ] }, { "id": 468, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 469, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a stored procedure call." }, "typeParameter": [ { "id": 470, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 471, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The function name to call." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 472, "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": 473, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 474, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 475, "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": [ 475 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 55, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "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": [ 451 ] }, { "title": "Properties", "kind": 1024, "children": [ 446, 450, 445 ] }, { "title": "Methods", "kind": 2048, "children": [ 461, 464, 468 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 5, "character": 36 } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 444 ] } ], "sources": [ { "fileName": "PostgrestClient.ts", "line": 1, "character": 0 } ] }, { "id": 476, "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": 126, "name": "\"lib/PostgrestFilterBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestFilterBuilder.ts", "children": [ { "id": 127, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 128, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 303, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 304, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 305, "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": 127, "name": "PostgrestFilterBuilder" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 40 } ], "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 214, "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": 210, "name": "rangeAdjacent" }, "defaultValue": "this.rangeAdjacent" }, { "id": 301, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "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": 189, "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": 185, "name": "containedBy" }, "defaultValue": "this.containedBy" }, { "id": 184, "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": 180, "name": "contains" }, "defaultValue": "this.contains" }, { "id": 296, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 298, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 299, "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": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 294, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "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": 204, "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": 200, "name": "rangeGte" }, "defaultValue": "this.rangeGte" }, { "id": 209, "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": 205, "name": "rangeLte" }, "defaultValue": "this.rangeLte" }, { "id": 219, "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": 215, "name": "overlaps" }, "defaultValue": "this.overlaps" }, { "id": 300, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 302, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 194, "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": 190, "name": "rangeLt" }, "defaultValue": "this.rangeLt" }, { "id": 199, "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": 195, "name": "rangeGt" }, "defaultValue": "this.rangeGt" }, { "id": 295, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 185, "name": "containedBy", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 186, "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": 187, "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": 188, "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": 180, "name": "contains", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "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": 182, "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": 183, "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": 292, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to CSV." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 98, "name": "PostgrestTransformBuilder.csv" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 126, "character": 5 } ], "inheritedFrom": { "type": "reference", "id": 98, "name": "PostgrestTransformBuilder.csv" } }, { "id": 140, "name": "eq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 141, "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": 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": 63, "character": 4 } ] }, { "id": 256, "name": "filter", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 257, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose `column` satisfies the filter." }, "parameters": [ { "id": 258, "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": 259, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 320, "name": "FilterOperator" } }, { "id": 260, "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": 228, "name": "fts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 229, "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": 230, "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": 231, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 232, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 233, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 234, "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": [ 234 ] } ], "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": 148, "name": "gt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 149, "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": 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": 87, "character": 4 } ] }, { "id": 152, "name": "gte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 153, "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": 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": "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": 168, "name": "ilike", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 169, "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": 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": "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": 176, "name": "in", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 177, "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": 178, "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": 179, "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": 172, "name": "is", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 173, "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": 174, "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": 175, "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": 164, "name": "like", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 165, "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": 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": "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": 275, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 276, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 277, "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": 278, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 279, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 280, "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": [ 280 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 22 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 81, "name": "PostgrestTransformBuilder.limit" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 66, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 81, "name": "PostgrestTransformBuilder.limit" } }, { "id": 156, "name": "lt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 157, "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": 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": "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": 160, "name": "lte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 161, "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": 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": "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": 261, "name": "match", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 262, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows whose columns match the specified `query` object." }, "parameters": [ { "id": 263, "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": "reference", "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record" } } ], "type": { "type": "intrinsic", "name": "this" } } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 441, "character": 7 } ] }, { "id": 290, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 291, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 65, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 96, "name": "PostgrestTransformBuilder.maybeSingle" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 102, "character": 13 } ], "inheritedFrom": { "type": "reference", "id": 96, "name": "PostgrestTransformBuilder.maybeSingle" } }, { "id": 144, "name": "neq", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 145, "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": 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": 75, "character": 5 } ] }, { "id": 129, "name": "not", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 130, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows which doesn't satisfy the filter." }, "parameters": [ { "id": 131, "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": 132, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The operator to filter with." }, "type": { "type": "reference", "id": 320, "name": "FilterOperator" } }, { "id": 133, "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": 134, "name": "or", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 135, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Finds all rows satisfying at least one of the filters." }, "parameters": [ { "id": 136, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The filters to use, separated by commas." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 137, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 139, "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": [ 139 ] } ], "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": 267, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 268, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 269, "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": 270, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 272, "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": 274, "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": 273, "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": [ 272, 274, 273 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 41, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder.order" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 40, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 73, "name": "PostgrestTransformBuilder.order" } }, { "id": 215, "name": "overlaps", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 216, "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": 217, "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": 218, "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": 242, "name": "phfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 243, "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": 244, "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": 245, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 246, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 247, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 248, "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": [ 248 ] } ], "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": 235, "name": "plfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 236, "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": 237, "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": 238, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 239, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 240, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 241, "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": [ 241 ] } ], "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": 281, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 282, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 283, "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": 284, "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": 285, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 287, "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": [ 287 ] } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 33 } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "id": 87, "name": "PostgrestTransformBuilder.range" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 79, "character": 7 } ], "inheritedFrom": { "type": "reference", "id": 87, "name": "PostgrestTransformBuilder.range" } }, { "id": 210, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 211, "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": 212, "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": 213, "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": 195, "name": "rangeGt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 196, "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": 197, "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": 198, "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": 200, "name": "rangeGte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 201, "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": 202, "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": 203, "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": 190, "name": "rangeLt", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 191, "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": 192, "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": 193, "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": 205, "name": "rangeLte", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 206, "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": 207, "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": 208, "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": 264, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 265, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 266, "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": 70, "name": "PostgrestTransformBuilder.select" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 13, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 70, "name": "PostgrestTransformBuilder.select" } }, { "id": 288, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 289, "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": 63, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" }, "inheritedFrom": { "type": "reference", "id": 94, "name": "PostgrestTransformBuilder.single" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 92, "character": 8 } ], "inheritedFrom": { "type": "reference", "id": 94, "name": "PostgrestTransformBuilder.single" } }, { "id": 220, "name": "textSearch", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 221, "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": 222, "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": 223, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 224, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 225, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 226, "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": 227, "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": [ 226, 227 ] } ], "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": 308, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 309, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 310, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 311, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 312, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 314, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 315, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "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": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 316, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 317, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 318, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 319, "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": 79, "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": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 306, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 307, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } }, { "id": 249, "name": "wfts", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 250, "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": 251, "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": 252, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The Postgres tsquery string to filter with." }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 253, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 255, "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": [ 255 ] } ], "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": [ 303 ] }, { "title": "Properties", "kind": 1024, "children": [ 214, 301, 189, 184, 296, 294, 204, 209, 219, 300, 302, 194, 199, 295 ] }, { "title": "Methods", "kind": 2048, "children": [ 185, 180, 292, 140, 256, 228, 148, 152, 168, 176, 172, 164, 275, 156, 160, 261, 290, 144, 129, 134, 267, 215, 242, 235, 281, 210, 195, 200, 190, 205, 264, 288, 220, 308, 306, 249 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 31, "character": 43 } ], "extendedTypes": [ { "type": "reference", "id": 68, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] }, { "id": 320, "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": [ 127 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ 320 ] } ], "sources": [ { "fileName": "lib/PostgrestFilterBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 321, "name": "\"lib/PostgrestQueryBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestQueryBuilder.ts", "children": [ { "id": 322, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 323, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 324, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 325, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 326, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 327, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 328, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 329, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 7, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 330, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 331, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 332, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 333, "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": [ 329, 333 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 322, "name": "PostgrestQueryBuilder" }, "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 4, "character": 75 } ], "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 385, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "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": 380, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 381, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 382, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 383, "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": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 378, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "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": 384, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 386, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 379, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 372, "name": "delete", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 373, "name": "delete", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs a DELETE on the table." }, "parameters": [ { "id": 374, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__0", "type": { "type": "reflection", "declaration": { "id": 375, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 377, "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": 197, "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": 376, "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": 196, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 377, 376 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 195, "character": 9 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 195, "character": 8 } ] }, { "id": 341, "name": "insert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 342, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an INSERT into the table." }, "parameters": [ { "id": 343, "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": 344, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 345, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 347, "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": 346, "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": [ 347, 346 ] } ] } } ] } } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } }, { "id": 348, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "tags": [ { "tag": "deprecated", "text": "Use `upsert()` instead.\n" } ] }, "parameters": [ { "id": 349, "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": 350, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reflection", "declaration": { "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 355, "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": 353, "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": 354, "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": 352, "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": [ 355, 353, 354, 352 ] } ] } } ] } } ], "type": { "type": "reference", "id": 127, "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": 334, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 335, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 336, "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": 337, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 340, "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": 339, "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": [ 340, 339 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 23, "character": 18 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 22, "character": 8 } ] }, { "id": 389, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 390, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 391, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 392, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 393, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 395, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 396, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "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": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 397, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 399, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 400, "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": 79, "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": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 387, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 388, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } }, { "id": 365, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 366, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPDATE on the table." }, "parameters": [ { "id": 367, "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": 368, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 371, "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": 173, "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": 370, "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": 172, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 371, 370 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 170, "character": 23 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 169, "character": 8 } ] }, { "id": 356, "name": "upsert", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 357, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs an UPSERT into the table." }, "parameters": [ { "id": 358, "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": 359, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 360, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 363, "name": "count", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Count algorithm to use to count rows in a table." }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 135, "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": 364, "name": "ignoreDuplicates", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "comment": { "text": "Specifies if duplicate rows should be ignored and not inserted.\n" }, "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 136, "character": 22 } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 361, "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": 133, "character": 16 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 362, "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": 134, "character": 15 } ], "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "minimal" }, { "type": "stringLiteral", "value": "representation" } ] }, "defaultValue": "\"representation\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 363, 364, 361, 362 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 131, "character": 38 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 130, "character": 8 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 324 ] }, { "title": "Properties", "kind": 1024, "children": [ 385, 380, 378, 384, 386, 379 ] }, { "title": "Methods", "kind": 2048, "children": [ 372, 341, 334, 389, 387, 365, 356 ] } ], "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": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 322 ] } ], "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 401, "name": "\"lib/PostgrestRpcBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestRpcBuilder.ts", "children": [ { "id": 402, "name": "PostgrestRpcBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "typeParameter": [ { "id": 403, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 404, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 405, "name": "new PostgrestRpcBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 406, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 407, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 409, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 7, "character": 13 } ], "type": { "type": "reflection", "declaration": { "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 411, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 412, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 413, "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": [ 409, 413 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 6, "character": 16 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 402, "name": "PostgrestRpcBuilder" }, "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 4, "character": 73 } ], "overwrites": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 427, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "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": 422, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 424, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 425, "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": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 420, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "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": 426, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 428, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 421, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 414, "name": "rpc", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 415, "name": "rpc", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform a stored procedure call." }, "parameters": [ { "id": 416, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "object" } ] } }, { "id": 417, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 418, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 419, "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": [ 419 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 19, "character": 20 } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "id": 127, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestFilterBuilder" } } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 18, "character": 5 } ] }, { "id": 431, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 432, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 433, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 434, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 435, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 437, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 438, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "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": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 439, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 440, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 441, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 442, "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": 79, "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": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 429, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 430, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 404 ] }, { "title": "Properties", "kind": 1024, "children": [ 427, 422, 420, 426, 428, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ 414, 431, 429 ] } ], "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": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 402 ] } ], "sources": [ { "fileName": "lib/PostgrestRpcBuilder.ts", "line": 1, "character": 0 } ] }, { "id": 67, "name": "\"lib/PostgrestTransformBuilder\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/postgrest-js/postgrest-js/src/lib/PostgrestTransformBuilder.ts", "children": [ { "id": 68, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "comment": { "shortText": "Post-filters (transforms)" }, "typeParameter": [ { "id": 69, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "children": [ { "id": 109, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 110, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 111, "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": 68, "name": "PostgrestTransformBuilder" }, "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 40 } ], "inheritedFrom": { "type": "reference", "id": 38, "name": "PostgrestBuilder.__constructor" } }, { "id": 107, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "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": 102, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 54, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 103, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 104, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 105, "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": 54, "character": 21 } ] } }, "inheritedFrom": { "type": "reference", "id": 31, "name": "PostgrestBuilder.headers" } }, { "id": 100, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "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": 106, "name": "schema", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "id": 35, "name": "PostgrestBuilder.schema" } }, { "id": 108, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] }, "inheritedFrom": { "type": "reference", "id": 37, "name": "PostgrestBuilder.shouldThrowOnError" } }, { "id": 101, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" }, "inheritedFrom": { "type": "reference", "id": 30, "name": "PostgrestBuilder.url" } }, { "id": 98, "name": "csv", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 99, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Set the response type to CSV." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 63, "typeArguments": [ { "type": "intrinsic", "name": "string" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 126, "character": 5 } ] }, { "id": 81, "name": "limit", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 82, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result with the specified `count`." }, "parameters": [ { "id": 83, "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": 84, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 85, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 86, "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": [ 86 ] } ], "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": 96, "name": "maybeSingle", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 97, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", "id": 65, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestMaybeSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 102, "character": 13 } ] }, { "id": 73, "name": "order", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 74, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Orders the result with the specified `column`." }, "parameters": [ { "id": 75, "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": 76, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__1", "type": { "type": "reflection", "declaration": { "id": 77, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 78, "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": 80, "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": 79, "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": [ 78, 80, 79 ] } ], "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": 87, "name": "range", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 88, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Limits the result to rows within the specified range, inclusive." }, "parameters": [ { "id": 89, "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": 90, "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": 91, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "originalName": "__2", "type": { "type": "reflection", "declaration": { "id": 92, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 93, "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": [ 93 ] } ], "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": 70, "name": "select", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 71, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Performs vertical filtering with SELECT." }, "parameters": [ { "id": 72, "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": 94, "name": "single", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 95, "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": 63, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestSingleResponse" } ], "name": "PromiseLike" } } ], "sources": [ { "fileName": "lib/PostgrestTransformBuilder.ts", "line": 92, "character": 8 } ] }, { "id": 114, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 115, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 116, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 117, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 118, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 119, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 120, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 121, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "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": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 122, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 124, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 125, "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": 79, "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": 43, "name": "PostgrestBuilder.then" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 74, "character": 6 } ], "inheritedFrom": { "type": "reference", "id": 43, "name": "PostgrestBuilder.then" } }, { "id": 112, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 113, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" }, "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ], "inheritedFrom": { "type": "reference", "id": 41, "name": "PostgrestBuilder.throwOnError" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 109 ] }, { "title": "Properties", "kind": 1024, "children": [ 107, 102, 100, 106, 108, 101 ] }, { "title": "Methods", "kind": 2048, "children": [ 98, 81, 96, 73, 87, 70, 94, 114, 112 ] } ], "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": 127, "name": "PostgrestFilterBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestResponse" } ], "name": "PromiseLike" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 68 ] } ], "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": 38, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 39, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 40, "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": 57, "character": 40 } ] }, { "id": 36, "name": "body", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 56, "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": 54, "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": 54, "character": 21 } ] } } }, { "id": 29, "name": "method", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 52, "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": 55, "character": 18 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 37, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 57, "character": 30 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } }, { "id": 30, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 53, "character": 15 } ], "type": { "type": "reference", "name": "URL" } }, { "id": 43, "name": "then", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 44, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "typeParameter": [ { "id": 45, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } }, { "id": 46, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "parameters": [ { "id": 47, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 49, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 50, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reference", "id": 61, "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": 76, "character": 9 } ] } }, { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 51, "name": "onrejected", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 52, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "signatures": [ { "id": 53, "name": "__call", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 54, "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": 79, "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": 74, "character": 6 } ] }, { "id": 41, "name": "throwOnError", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 42, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { "type": "reference", "id": 27, "typeArguments": [ { "type": "typeParameter", "name": "T" } ], "name": "PostgrestBuilder" } } ], "sources": [ { "fileName": "lib/types.ts", "line": 69, "character": 14 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 38 ] }, { "title": "Properties", "kind": 1024, "children": [ 36, 31, 29, 35, 37, 30 ] }, { "title": "Methods", "kind": 2048, "children": [ 43, 41 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 51, "character": 38 } ], "extendedBy": [ { "type": "reference", "id": 68, "name": "PostgrestTransformBuilder" }, { "type": "reference", "id": 322, "name": "PostgrestQueryBuilder" }, { "type": "reference", "id": 402, "name": "PostgrestRpcBuilder" } ], "implementedTypes": [ { "type": "reference", "typeArguments": [ { "type": "reference", "id": 61, "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": 55, "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": 55, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "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": 26 } ], "type": { "type": "reflection", "declaration": { "id": 56, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 60, "name": "code", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 12, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 58, "name": "details", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 10, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 59, "name": "hint", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 11, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 57, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 9, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 60, 58, 59, 57 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 8, "character": 28 } ] } } }, { "id": 65, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 66, "name": "T", "kind": 131072, "kindString": "Type parameter", "flags": { "isExported": true } } ], "sources": [ { "fileName": "lib/types.ts", "line": 49, "character": 40 } ], "type": { "type": "reference", "id": 63, "typeArguments": [ { "type": "union", "types": [ { "type": "typeParameter", "name": "T" }, { "type": "intrinsic", "name": "null" } ] } ], "name": "PostgrestSingleResponse" } }, { "id": 61, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 62, "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": 63, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", "flags": { "isExported": true }, "typeParameter": [ { "id": 64, "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": [ 55, 65, 61, 63 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [ 443, 476, 126, 321, 401, 67, 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": { "isExported": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 14, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 309, "name": "decode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 21, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 308, "name": "encode", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 20, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 311, "name": "headers", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "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": { "isExported": true }, "indexSignature": [ { "id": 313, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 314, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 305, "name": "heartbeatIntervalMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "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": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 19, "character": 8 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 306, "name": "longpollerTimeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "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": { "isExported": true, "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": { "isExported": true }, "indexSignature": [ { "id": 317, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 318, "name": "key", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } ] } }, { "id": 310, "name": "reconnectAfterMs", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "RealtimeClient.ts", "line": 22, "character": 18 } ], "type": { "type": "reference", "name": "Function" } }, { "id": 304, "name": "timeout", "kind": 32, "kindString": "Variable", "flags": { "isExported": true, "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": { "isExported": true, "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": 21 } ] } } }, { "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": 270, "name": "\"SupabaseStorageClient\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/SupabaseStorageClient.ts", "children": [ { "id": 271, "name": "SupabaseStorageClient", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 272, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 273, "name": "new SupabaseStorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 274, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 275, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 276, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 277, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 278, "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": 271, "name": "SupabaseStorageClient" }, "overwrites": { "type": "reference", "id": 96, "name": "StorageBucketApi.__constructor" } } ], "sources": [ { "fileName": "SupabaseStorageClient.ts", "line": 3, "character": 61 } ], "overwrites": { "type": "reference", "id": 96, "name": "StorageBucketApi.__constructor" } }, { "id": 283, "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": 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/StorageBucketApi.ts", "line": 6, "character": 20 } ] } }, "inheritedFrom": { "type": "reference", "id": 92, "name": "StorageBucketApi.headers" } }, { "id": 282, "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": 91, "name": "StorageBucketApi.url" } }, { "id": 298, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 299, "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": 300, "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" } }, { "id": 301, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 302, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 303, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 47, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 303 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 47, "character": 12 } ] } }, "defaultValue": "{ public: false }" } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 305, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 48, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 306, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 48, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 305, 306 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 48, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 114, "name": "StorageBucketApi.createBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 45, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 114, "name": "StorageBucketApi.createBucket" } }, { "id": 326, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 327, "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": 328, "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": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 330, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 331, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 332, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 332 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 333, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 330, 333 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 142, "name": "StorageBucketApi.deleteBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 104, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 142, "name": "StorageBucketApi.deleteBucket" } }, { "id": 318, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 319, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 320, "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": 321, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 322, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 323, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 324, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 324 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 325, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 322, 325 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 134, "name": "StorageBucketApi.emptyBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 87, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 134, "name": "StorageBucketApi.emptyBucket" } }, { "id": 279, "name": "from", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 280, "name": "from", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Perform file operation in a bucket." }, "parameters": [ { "id": 281, "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": 154, "name": "StorageFileApi" } } ], "sources": [ { "fileName": "SupabaseStorageClient.ts", "line": 13, "character": 6 } ] }, { "id": 292, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 293, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 294, "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": 295, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 296, "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": 297, "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": [ 296, 297 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 30, "character": 39 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 108, "name": "StorageBucketApi.getBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 30, "character": 17 } ], "inheritedFrom": { "type": "reference", "id": 108, "name": "StorageBucketApi.getBucket" } }, { "id": 287, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 288, "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": 289, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 290, "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": 291, "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": [ 290, 291 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 16, "character": 31 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 103, "name": "StorageBucketApi.listBuckets" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 16, "character": 19 } ], "inheritedFrom": { "type": "reference", "id": 103, "name": "StorageBucketApi.listBuckets" } }, { "id": 307, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 308, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates a new Storage bucket" }, "parameters": [ { "id": 309, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A unique identifier for the bucket you are creating.\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 310, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 311, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 312, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 68, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 312 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 68, "character": 12 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 314, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 316, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 316 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 317, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 314, 317 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 13 } ] } } ], "name": "Promise" }, "inheritedFrom": { "type": "reference", "id": 123, "name": "StorageBucketApi.updateBucket" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 66, "character": 20 } ], "inheritedFrom": { "type": "reference", "id": 123, "name": "StorageBucketApi.updateBucket" } } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 272 ] }, { "title": "Properties", "kind": 1024, "children": [ 283, 282 ] }, { "title": "Methods", "kind": 2048, "children": [ 298, 326, 318, 279, 292, 287, 307 ] } ], "sources": [ { "fileName": "SupabaseStorageClient.ts", "line": 3, "character": 34 } ], "extendedTypes": [ { "type": "reference", "id": 90, "name": "StorageBucketApi" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 271 ] } ], "sources": [ { "fileName": "SupabaseStorageClient.ts", "line": 1, "character": 0 } ] }, { "id": 334, "name": "\"index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/index.ts", "children": [ { "id": 335, "name": "Bucket", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 58 }, { "id": 336, "name": "FileObject", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 65 }, { "id": 338, "name": "FileOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 79 }, { "id": 340, "name": "Metadata", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 87 }, { "id": 339, "name": "SearchOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 83 }, { "id": 337, "name": "SortBy", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 76 } ], "groups": [ { "title": "References", "kind": 16777216, "children": [ 335, 336, 338, 340, 339, 337 ] } ], "sources": [ { "fileName": "index.ts", "line": 1, "character": 0 } ] }, { "id": 89, "name": "\"lib/StorageBucketApi\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageBucketApi.ts", "children": [ { "id": 90, "name": "StorageBucketApi", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 96, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 97, "name": "new StorageBucketApi", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 98, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 99, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 100, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 101, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 102, "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": 90, "name": "StorageBucketApi" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 6, "character": 46 } ] }, { "id": 92, "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": 93, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 94, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 95, "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": 91, "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": 114, "name": "createBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 115, "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": 116, "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" } }, { "id": 117, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 119, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 47, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 119 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 47, "character": 12 } ] } }, "defaultValue": "{ public: false }" } ], "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": 48, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 122, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 48, "character": 41 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 121, 122 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 48, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 45, "character": 20 } ] }, { "id": 142, "name": "deleteBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 143, "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": 144, "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": 145, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 146, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 147, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 148, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 148 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 149, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 146, 149 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 106, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 104, "character": 20 } ] }, { "id": 134, "name": "emptyBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 135, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Removes all objects inside a single bucket." }, "parameters": [ { "id": 136, "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": 137, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 138, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 139, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 140, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 140 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 141, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 138, 141 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 89, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 87, "character": 19 } ] }, { "id": 108, "name": "getBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 109, "name": "getBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieves the details of an existing Storage bucket." }, "parameters": [ { "id": 110, "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": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 112, "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": 113, "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": [ 112, 113 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 30, "character": 39 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 30, "character": 17 } ] }, { "id": 103, "name": "listBuckets", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 104, "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": 105, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 106, "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": 107, "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": [ 106, 107 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 16, "character": 31 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 16, "character": 19 } ] }, { "id": 123, "name": "updateBucket", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 124, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Updates a new Storage bucket" }, "parameters": [ { "id": 125, "name": "id", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "A unique identifier for the bucket you are creating.\n" }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 126, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 128, "name": "public", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 68, "character": 21 } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 128 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 68, "character": 12 } ] } } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 129, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 130, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 131, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 132, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 132 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 133, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 130, 133 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 69, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 66, "character": 20 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 96 ] }, { "title": "Properties", "kind": 1024, "children": [ 92, 91 ] }, { "title": "Methods", "kind": 2048, "children": [ 114, 142, 134, 108, 103, 123 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 4, "character": 29 } ], "extendedBy": [ { "type": "reference", "id": 271, "name": "SupabaseStorageClient" } ] } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 90 ] } ], "sources": [ { "fileName": "lib/StorageBucketApi.ts", "line": 1, "character": 0 } ] }, { "id": 153, "name": "\"lib/StorageFileApi\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageFileApi.ts", "children": [ { "id": 154, "name": "StorageFileApi", "kind": 128, "kindString": "Class", "flags": { "isExported": true }, "children": [ { "id": 161, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": { "isExported": true }, "signatures": [ { "id": 162, "name": "new StorageFileApi", "kind": 16384, "kindString": "Constructor signature", "flags": { "isExported": true }, "parameters": [ { "id": 163, "name": "url", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 164, "name": "headers", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "type": { "type": "reflection", "declaration": { "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 166, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 167, "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": 26, "character": 35 } ] } }, "defaultValue": "{}" }, { "id": 168, "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": 154, "name": "StorageFileApi" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 24, "character": 29 } ] }, { "id": 160, "name": "bucketId", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 24, "character": 20 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 23, "character": 19 } ], "type": { "type": "reflection", "declaration": { "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "indexSignature": [ { "id": 158, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": { "isExported": true }, "parameters": [ { "id": 159, "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": 20 } ] } } }, { "id": 155, "name": "url", "kind": 1024, "kindString": "Property", "flags": { "isProtected": true, "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 22, "character": 15 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 248, "name": "_getFinalPath", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 249, "name": "_getFinalPath", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "parameters": [ { "id": 250, "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": 321, "character": 15 } ] }, { "id": 209, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 210, "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": 211, "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": 212, "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": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 214, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 188, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 215, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 216, "name": "signedURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 188, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 216 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 188, "character": 9 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 217, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 189, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 218, "name": "signedURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 190, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 214, 217, 218 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 187, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 184, "character": 23 } ] }, { "id": 219, "name": "download", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 220, "name": "download", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Downloads a file." }, "parameters": [ { "id": 221, "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": 222, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 223, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 212, "character": 46 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Blob" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 224, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 212, "character": 66 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 223, 224 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 212, "character": 40 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 212, "character": 16 } ] }, { "id": 225, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 226, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Retrieve URLs for assets in public buckets" }, "parameters": [ { "id": 227, "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": "reflection", "declaration": { "id": 228, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 229, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 234, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 231, "name": "publicURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 234, "character": 21 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 231 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 234, "character": 9 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 232, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 235, "character": 9 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 233, "name": "publicURL", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 236, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 229, 232, 233 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 233, "character": 4 } ] } } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 231, "character": 14 } ] }, { "id": 240, "name": "list", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 241, "name": "list", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Lists all the files within a bucket." }, "parameters": [ { "id": 242, "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": 243, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "Search options, including `limit`, `offset`, and `sortBy`." }, "type": { "type": "reference", "id": 83, "name": "SearchOptions" } }, { "id": 244, "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": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 246, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 306, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 65, "name": "FileObject" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 247, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 306, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 246, 247 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 306, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 302, "character": 12 } ] }, { "id": 200, "name": "move", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 201, "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": 202, "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": 203, "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": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 205, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 165, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 206, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 207, "name": "message", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 165, "character": 30 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 207 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 165, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 208, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 165, "character": 54 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 205, 208 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 165, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 162, "character": 12 } ] }, { "id": 234, "name": "remove", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 235, "name": "remove", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Deletes files within the same bucket" }, "parameters": [ { "id": 236, "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": 237, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 238, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 253, "character": 47 } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "id": 65, "name": "FileObject" } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 239, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 253, "character": 75 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 238, 239 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 253, "character": 41 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 253, "character": 14 } ] }, { "id": 190, "name": "update", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 191, "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": 192, "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": 193, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The body of the file to be stored in the bucket." }, "type": { "type": "union", "types": [ { "type": "reference", "name": "ArrayBuffer" }, { "type": "reference", "name": "ArrayBufferView" }, { "type": "reference", "name": "Blob" }, { "type": "reference", "name": "Buffer" }, { "type": "reference", "name": "File" }, { "type": "reference", "name": "FormData" }, { "type": "reference", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "reference", "name": "Uint8Array" } ], "name": "ReadableStream" }, { "type": "reference", "name": "URLSearchParams" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 194, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "HTTP headers.\n`cacheControl`: string, the `Cache-Control: max-age=` seconds value.\n`contentType`: string, the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`.\n`upsert`: boolean, whether to perform an upsert.\n" }, "type": { "type": "reference", "id": 79, "name": "FileOptions" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 195, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 196, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 152, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 198, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 152, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 198 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 152, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 199, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 152, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 196, 199 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 152, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 138, "character": 14 } ] }, { "id": 180, "name": "upload", "kind": 2048, "kindString": "Method", "flags": { "isExported": true }, "signatures": [ { "id": 181, "name": "upload", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Uploads a file to an existing bucket." }, "parameters": [ { "id": 182, "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": 183, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The body of the file to be stored in the bucket." }, "type": { "type": "union", "types": [ { "type": "reference", "name": "ArrayBuffer" }, { "type": "reference", "name": "ArrayBufferView" }, { "type": "reference", "name": "Blob" }, { "type": "reference", "name": "Buffer" }, { "type": "reference", "name": "File" }, { "type": "reference", "name": "FormData" }, { "type": "reference", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "reference", "name": "Uint8Array" } ], "name": "ReadableStream" }, { "type": "reference", "name": "URLSearchParams" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 184, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "HTTP headers.\n`cacheControl`: string, the `Cache-Control: max-age=` seconds value.\n`contentType`: string, the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`.\n`upsert`: boolean, whether to perform an upsert.\n" }, "type": { "type": "reference", "id": 79, "name": "FileOptions" } } ], "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": 124, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 188, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 124, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 188 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 124, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 189, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 124, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 186, 189 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 124, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 110, "character": 14 } ] }, { "id": 169, "name": "uploadOrUpdate", "kind": 2048, "kindString": "Method", "flags": { "isPrivate": true, "isExported": true }, "signatures": [ { "id": 170, "name": "uploadOrUpdate", "kind": 4096, "kindString": "Call signature", "flags": { "isExported": true }, "comment": { "shortText": "Uploads a file to an existing bucket or replaces an existing file at the specified path with a new one." }, "parameters": [ { "id": 171, "name": "method", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "HTTP method." }, "type": { "type": "union", "types": [ { "type": "stringLiteral", "value": "POST" }, { "type": "stringLiteral", "value": "PUT" } ] } }, { "id": 172, "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": 173, "name": "fileBody", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, "comment": { "text": "The body of the file to be stored in the bucket." }, "type": { "type": "union", "types": [ { "type": "reference", "name": "ArrayBuffer" }, { "type": "reference", "name": "ArrayBufferView" }, { "type": "reference", "name": "Blob" }, { "type": "reference", "name": "Buffer" }, { "type": "reference", "name": "File" }, { "type": "reference", "name": "FormData" }, { "type": "reference", "name": "ReadableStream" }, { "type": "reference", "typeArguments": [ { "type": "reference", "name": "Uint8Array" } ], "name": "ReadableStream" }, { "type": "reference", "name": "URLSearchParams" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 174, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true, "isOptional": true }, "comment": { "text": "HTTP headers.\n`cacheControl`: string, the `Cache-Control: max-age=` seconds value.\n`contentType`: string, the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`.\n`upsert`: boolean, whether to perform an upsert.\n" }, "type": { "type": "reference", "id": 79, "name": "FileOptions" } } ], "type": { "type": "reference", "typeArguments": [ { "type": "reflection", "declaration": { "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 176, "name": "data", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 58, "character": 19 } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "children": [ { "id": 178, "name": "Key", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 58, "character": 26 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 178 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 58, "character": 20 } ] } }, { "type": "intrinsic", "name": "null" } ] } }, { "id": 179, "name": "error", "kind": 32, "kindString": "Variable", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 58, "character": 50 } ], "type": { "type": "union", "types": [ { "type": "reference", "name": "Error" }, { "type": "intrinsic", "name": "null" } ] } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 176, 179 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 58, "character": 13 } ] } } ], "name": "Promise" } } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 43, "character": 30 } ] } ], "groups": [ { "title": "Constructors", "kind": 512, "children": [ 161 ] }, { "title": "Properties", "kind": 1024, "children": [ 160, 156, 155 ] }, { "title": "Methods", "kind": 2048, "children": [ 248, 209, 219, 225, 240, 200, 234, 190, 180, 169 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 21, "character": 27 } ] }, { "id": 257, "name": "DEFAULT_FILE_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 258, "name": "cacheControl", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 16, "character": 14 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"3600\"" }, { "id": 259, "name": "contentType", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 17, "character": 13 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"text/plain;charset=UTF-8\"" }, { "id": 260, "name": "upsert", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 18, "character": 8 } ], "type": { "type": "intrinsic", "name": "false" }, "defaultValue": "false" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 258, 259, 260 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 15, "character": 26 } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 251, "name": "DEFAULT_SEARCH_OPTIONS", "kind": 2097152, "kindString": "Object literal", "flags": { "isConst": true }, "children": [ { "id": 252, "name": "limit", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 7, "character": 7 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "100" }, { "id": 253, "name": "offset", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 8, "character": 8 } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "0" }, { "id": 254, "name": "sortBy", "kind": 2097152, "kindString": "Object literal", "flags": {}, "children": [ { "id": 255, "name": "column", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 10, "character": 10 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"name\"" }, { "id": 256, "name": "order", "kind": 32, "kindString": "Variable", "flags": {}, "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 11, "character": 9 } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "\"asc\"" } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 255, 256 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 9, "character": 8 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Variables", "kind": 32, "children": [ 252, 253 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 254 ] } ], "sources": [ { "fileName": "lib/StorageFileApi.ts", "line": 6, "character": 28 } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Classes", "kind": 128, "children": [ 154 ] }, { "title": "Object literals", "kind": 2097152, "children": [ 257, 251 ] } ], "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": 150, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/lib/helpers.ts", "children": [ { "id": 151, "name": "isBrowser", "kind": 64, "kindString": "Function", "flags": { "isExported": true, "isConst": true }, "signatures": [ { "id": 152, "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": [ 151 ] } ], "sources": [ { "fileName": "lib/helpers.ts", "line": 1, "character": 0 } ] }, { "id": 261, "name": "\"lib/index\"", "kind": 1, "kindString": "Module", "flags": { "isExported": true }, "originalName": "/home/runner/work/storage-js/storage-js/src/lib/index.ts", "children": [ { "id": 264, "name": "Bucket", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 58 }, { "id": 265, "name": "FileObject", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 65 }, { "id": 267, "name": "FileOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 79 }, { "id": 269, "name": "Metadata", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 87 }, { "id": 268, "name": "SearchOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 83 }, { "id": 266, "name": "SortBy", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 76 }, { "id": 262, "name": "StorageBucketApi", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 90 }, { "id": 263, "name": "StorageFileApi", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, "target": 154 } ], "groups": [ { "title": "References", "kind": 16777216, "children": [ 264, 265, 267, 269, 268, 266, 262, 263 ] } ], "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": 64, "name": "public", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 7, "character": 8 } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "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, 64, 63 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 23 } ] }, { "id": 65, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 67, "name": "bucket_id", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 12, "character": 11 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 75, "name": "buckets", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 19, "character": 9 } ], "type": { "type": "reference", "id": 58, "name": "Bucket" } }, { "id": 71, "name": "created_at", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 16, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 69, "name": "id", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 14, "character": 4 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 72, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 17, "character": 18 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 73, "name": "metadata", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 18, "character": 10 } ], "type": { "type": "reflection", "declaration": { "id": 74, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 18, "character": 11 } ] } } }, { "id": 66, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 11, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 68, "name": "owner", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 13, "character": 7 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 70, "name": "updated_at", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 15, "character": 12 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 67, 75, 71, 69, 72, 73, 66, 68, 70 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 10, "character": 27 } ] }, { "id": 79, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 80, "name": "cacheControl", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 28, "character": 14 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 81, "name": "contentType", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 29, "character": 13 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 82, "name": "upsert", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 30, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "false" }, { "type": "intrinsic", "name": "true" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 80, 81, 82 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 27, "character": 28 } ] }, { "id": 87, "name": "Metadata", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 88, "name": "name", "kind": 1024, "kindString": "Property", "flags": { "isExported": true }, "sources": [ { "fileName": "lib/types.ts", "line": 46, "character": 6 } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 88 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 45, "character": 25 } ] }, { "id": 83, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 84, "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": 35, "character": 7 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 85, "name": "offset", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "comment": { "shortText": "The starting position." }, "sources": [ { "fileName": "lib/types.ts", "line": 38, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 86, "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": 41, "character": 8 } ], "type": { "type": "reference", "id": 76, "name": "SortBy" } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 84, 85, 86 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 33, "character": 30 } ] }, { "id": 76, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": { "isExported": true }, "children": [ { "id": 77, "name": "column", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 23, "character": 8 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 78, "name": "order", "kind": 1024, "kindString": "Property", "flags": { "isExported": true, "isOptional": true }, "sources": [ { "fileName": "lib/types.ts", "line": 24, "character": 7 } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "kind": 1024, "children": [ 77, 78 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 22, "character": 23 } ] } ], "groups": [ { "title": "Interfaces", "kind": 256, "children": [ 58, 65, 79, 87, 83, 76 ] } ], "sources": [ { "fileName": "lib/types.ts", "line": 1, "character": 0 } ] } ], "groups": [ { "title": "Modules", "kind": 1, "children": [ 270, 334, 89, 153, 1, 150, 261, 57 ] } ] } ] }